ClickTale Wiki - User contributions [en]

ClickTale Enterprise

2011-12-07T11:49:12Z

Shmuls:

[[ClickTale Enterprise]] is a customized ClickTale plan with advanced functionality, extensive training and proactive support.
__TOC__
==Online Plan Limitations==
If a website has over 1,000,000 page views a month in total, it cannot be tracked with an online plan, and needs to use [[ClickTale Enterprise]] instead.
===Justification===
Every visitor that comes to a site tracked by ClickTale sends a request to the ClickTale servers to ask whether or not it should be recorded. Although sites using an online plan may only choose to record a small percentage of their traffic, the ClickTale servers are still receiving a lot of requests. For that reason, any domain that has over 1,000,000 page views a month, must be directed to a ClickTale Enterprise server instead on a standard online plan.

==Additional Benefits==
===Scalable and Robust===
Built from the ground up to support larger enterprise sites with the scalability to cope with the world’s largest websites. Constantly optimized and upgraded to ensure lightning fast speeds and negligible effect on site performance.
===Expert Consultation===
A ClickTale Customer Experience Expert will help you define your KPIs, review your results, highlight key areas of visitor behavior and recommend actionable steps to improve your conversions and usability.
===Segmented Reports===
Filter your visitors based on specific behaviors to create segmented reports delivering unparalleled insights.
===Extensive Training and Education===
Comprehensive training webinars covering both the business applications and technical aspects of ClickTale, ensuring a quicker return on investment.
===Installation Guarantee===
Custom setup and installation support to guarantee that ClickTale is correctly implemented and operational on your website.
===Ongoing Support===
A dedicated support team available to answer any questions you may have regarding ClickTale features, services or integrations, any time of the day.
===3rd party integrations===
Full support for integration with Omniture, Silverpop, Exact Target, iContact, Constant Contact and many others.
==ClickTale Enterprise Vs ClickTale Online?==
===Unlimited Total Website Traffic ===
With ClickTale Enterprise you will have the ability to run ClickTale on your website without any total traffic restrictions. ClickTale Enterprise is built on a dedicated infrastructure designed to handle the largest websites in the world with unlimited total traffic to your website.
===No Maximum Recording Limit===
As well as being able to cope with as much traffic to your website as necessary, ClickTale Enterprise can scale to record every single visitor to your website. Our packages start at 500,000 recordings per month but can be tailored to suite your needs.
===Is it still a hosted service?===
ClickTale Enterprise is still delivered as a hosted Software as a Service, this enables the same easy implementation and ease of use, without any hardware needs at your end. If you are interested in a dedicated server or onsite installation please contact us and we can work toward tailoring a solution.
===Segmentation and Filtering===
All of our reports have powerful aggregate views of activity on your website in both form analytics and heatmaps; however to gain the most value it is important to filter your reports to understand more defined trends. An example being the ability to see heatmaps based only on new users as opposed to customers logging in from the homepage. Another way this is used is to break up user trends based on refers and affiliates, PPC acidity or specific campaigns.
===Large Scale Aggregate View===
All heatmaps and form analytics reports are available for over 100,000 page views. This allows you to really see aggregate trends across a large scale of your user base or segmented analysis. This is opposed to a view of 1,000 page views in ClickTale Online. We will also shortly be adding offline reports where you can request specific reports for hundreds of thousands of page views which we will calculate offline and distribute to you within a few hours.
===Dedicated Technical Support Representative===
ClickTale Enterprise is offered as consultative approach to your web analytics. You are assigned an account team with a dedicated account manager and technical support representative. This takes the meaning of advanced customer support to a new level. Not only will your support representative work with you to ensure that ClickTale is implemented efficiently, but they will work with you having an understanding of your infrastructure and help you with any problems in an individual manner. You will have their direct phone number ensuring support is not just an anonymous generic e-mail for you. They will also help you when incorporating new technologies or site changes and ensure everything from the technical level is smooth and efficient.
===Consultation and Education===
Your account manager is your single point of contact at ClickTale. They will work pro-actively with you, understanding more about your website technologies and aims. They will be able to work with you to identify the most valuable reports to create helping you build these into ClickTale. He will also help with analysis and bring suggestions to the output he is seeing from ClickTale.

This consultative approach also extends to education sessions where we can quickly train up users within your organization so they can start defining their own reports and understanding behaviors on specific conversation processes or pages.

ClickTale Enterprise

2011-12-07T11:48:36Z

Shmuls:

[[ClickTale Enterprise]] is a customized plan with advanced functionality, extensive training and proactive support.
__TOC__
==Online Plan Limitations==
If a website has over 1,000,000 page views a month in total, it cannot be tracked with an online plan, and needs to use [[ClickTale Enterprise]] instead.
===Justification===
Every visitor that comes to a site tracked by ClickTale sends a request to the ClickTale servers to ask whether or not it should be recorded. Although sites using an online plan may only choose to record a small percentage of their traffic, the ClickTale servers are still receiving a lot of requests. For that reason, any domain that has over 1,000,000 page views a month, must be directed to a ClickTale Enterprise server instead on a standard online plan.

==Additional Benefits==
===Scalable and Robust===
Built from the ground up to support larger enterprise sites with the scalability to cope with the world’s largest websites. Constantly optimized and upgraded to ensure lightning fast speeds and negligible effect on site performance.
===Expert Consultation===
A ClickTale Customer Experience Expert will help you define your KPIs, review your results, highlight key areas of visitor behavior and recommend actionable steps to improve your conversions and usability.
===Segmented Reports===
Filter your visitors based on specific behaviors to create segmented reports delivering unparalleled insights.
===Extensive Training and Education===
Comprehensive training webinars covering both the business applications and technical aspects of ClickTale, ensuring a quicker return on investment.
===Installation Guarantee===
Custom setup and installation support to guarantee that ClickTale is correctly implemented and operational on your website.
===Ongoing Support===
A dedicated support team available to answer any questions you may have regarding ClickTale features, services or integrations, any time of the day.
===3rd party integrations===
Full support for integration with Omniture, Silverpop, Exact Target, iContact, Constant Contact and many others.
==ClickTale Enterprise Vs ClickTale Online?==
===Unlimited Total Website Traffic ===
With ClickTale Enterprise you will have the ability to run ClickTale on your website without any total traffic restrictions. ClickTale Enterprise is built on a dedicated infrastructure designed to handle the largest websites in the world with unlimited total traffic to your website.
===No Maximum Recording Limit===
As well as being able to cope with as much traffic to your website as necessary, ClickTale Enterprise can scale to record every single visitor to your website. Our packages start at 500,000 recordings per month but can be tailored to suite your needs.
===Is it still a hosted service?===
ClickTale Enterprise is still delivered as a hosted Software as a Service, this enables the same easy implementation and ease of use, without any hardware needs at your end. If you are interested in a dedicated server or onsite installation please contact us and we can work toward tailoring a solution.
===Segmentation and Filtering===
All of our reports have powerful aggregate views of activity on your website in both form analytics and heatmaps; however to gain the most value it is important to filter your reports to understand more defined trends. An example being the ability to see heatmaps based only on new users as opposed to customers logging in from the homepage. Another way this is used is to break up user trends based on refers and affiliates, PPC acidity or specific campaigns.
===Large Scale Aggregate View===
All heatmaps and form analytics reports are available for over 100,000 page views. This allows you to really see aggregate trends across a large scale of your user base or segmented analysis. This is opposed to a view of 1,000 page views in ClickTale Online. We will also shortly be adding offline reports where you can request specific reports for hundreds of thousands of page views which we will calculate offline and distribute to you within a few hours.
===Dedicated Technical Support Representative===
ClickTale Enterprise is offered as consultative approach to your web analytics. You are assigned an account team with a dedicated account manager and technical support representative. This takes the meaning of advanced customer support to a new level. Not only will your support representative work with you to ensure that ClickTale is implemented efficiently, but they will work with you having an understanding of your infrastructure and help you with any problems in an individual manner. You will have their direct phone number ensuring support is not just an anonymous generic e-mail for you. They will also help you when incorporating new technologies or site changes and ensure everything from the technical level is smooth and efficient.
===Consultation and Education===
Your account manager is your single point of contact at ClickTale. They will work pro-actively with you, understanding more about your website technologies and aims. They will be able to work with you to identify the most valuable reports to create helping you build these into ClickTale. He will also help with analysis and bring suggestions to the output he is seeing from ClickTale.

This consultative approach also extends to education sessions where we can quickly train up users within your organization so they can start defining their own reports and understanding behaviors on specific conversation processes or pages.

Main Page

2011-10-11T15:19:31Z

Shmuls:

<br>
<big><big><big>'''Welcome to the new ClickTale Wiki!'''</big></big></big>
<br><br>
Eventually, this will be an online repository for everything to do with ClickTale, and hopefully website usability and optimization in general. For now we're just getting started. Feel free to have a look around. To contribute, please [http://www.clicktale.com/contact/contact_us contact us] and tell us about yourself and your plans so we can get you confirmed. You can check out [[Special:NewPages| new pages]] as we create them, and feel free to [[Requested pages|request a page]] you think we should have.
<br>
<br>
__TOC__
==Getting Started==
[[Quick Start Guide]] - A brief, step-by-step guide to ClickTale and its most common features.<br>
[[Frequently asked questions]] - The questions asked by most new users.<br>
[[Troubleshooting]] - How to fix the most common ClickTale errors.
==Setup and Customization==
[[Tracking code|The ClickTale Tracking code]] - How to generate the tracking code for standard ClickTale implementations.<br>
[[:Category:Plugins and Integrations|Plugins and Integrations]] - A comprehensive list of all ClickTale's plugins, modules and integrations.<br>
[[Sensitive data|Blocking sensitive data]] - How to stop ClickTale from recording sensitive data such as personal or financial details.
===Advanced Setup===
[[Recording JavaScript]] - How to record JavaScript within a webpage.<br>
[[Recording Flash]] - How to record actions over Flash elements.<br>
[[JavaScript API|ClickTale's JavaScript API]] - A comprehensive overview of all our API commands.<br>
[[Events]] - How to tag any visitor interaction as an Event.<br>
[[Recording Ratio]] - A deeper look at the recording ratio, and how to change it.<br>
[[Selective recordings]] - How to pick and choose what visitors you record based on a range of attributes.<br>
[[Offline recordings]] - How use ClickTale with offline environments and intranet sites.<br>
[[Managing domains]] - How to manage the domains that ClickTale records.
==Using ClickTale==
[[Dashboard|The Dashboard]]<br>
[[Visitor Playback]]
===Heatmaps===
[[Mouse Move Heatmaps]]<br>
[[Click Heatmaps]]<br>
[[Scroll-Reach Heatmaps]]<br>
[[Attention Heatmaps]]<br>
[[Link Analytics]]
===Search and Alerts===
[[Search|How to Search]]<br>
[[Search Filters]]<br>
[[Campaign Tracking]]<br>
[[Alerts|Creating Alerts]]
===Conversion Reports===
[[Conversion Funnels]]<br>
[[Form Analytics]]<br>
[[Behavioral reports]]
==Advanced Analytics==
[[ClickTale for Ecommerce]]<br>
[[A/B Testing|A/B and Multivariate Testing]]<br>
[[Terms|Terms and Definitions]]
==About ClickTale==
[[About us]]<br>
[http://www.clicktale.com/privacy_service.aspx Privacy policy]<br>
[http://www.clicktale.com/terms Terms of use]

Zend Framework integration

2011-10-09T13:57:56Z

Shmuls:

{{SMB}}
To incorporate the [[PHP integration module]] in a site using the Zend framework, you need to edit the index.php (the file which bootstraps the Zend controller and not your framework template).

In the beginning of the file, before any other text, add the PHP line to include the top part of the tracking code (as specified in step 7 of the module instructions), without the PHP tag:
<source lang="php">
require_once("[physical_path_to_clicktale_dir_here]\ClickTale\ClickTaleTop.php");
</source>
In the end of the file, after all other text, add the PHP line to include the bottom part of the tracking code (as specified in step 7 of the module instructions), without the PHP tag:
<source lang="php">
require_once("[physical_path_to_clicktale_dir_here]\ClickTale\ClickTaleBottom.php");
</source>
[[Category:Plugins and Integrations]]

Zen Cart integration

2011-10-09T13:57:52Z

Shmuls:

{{SMB}}
To incorporate the [[PHP integration module]] in a site using Zen Cart you need to perform the following;
#Download and extract the [[PHP integration module]] to a folder called ClickTale on your web-server
#Insert your tracking code into ClickTaleScripts.xml
#Insert references to ClickTale in /includes/application_top.php and /includes/application_bottom.php
For testing purposes a free user cannot record localhost sites so use the local machines IP instead, this will only record the front page, a subscription upgrade would be required to record the entire cart on localhost.

'''Here is example ClickTaleScripts.xml code for offline "localhost" testing:'''

<source lang="javascript">
<?xml version="1.0" encoding="utf-8" ?>
<scripts>
<script name="Top" DoNotReplaceCondition = "">
<![CDATA[

<script type="text/javascript">
var WRInitTime=(new Date()).getTime();
</script>

]]>
</script>

<script name="Bottom" DoNotReplaceCondition="" InsertBefore="|</body>">
<![CDATA[

<div id="ClickTaleDiv" style="display: none;"></div>
<script type="text/javascript">
if(document.location.protocol!='https:')
document.write(unescape("%3Cscript%20src='http://s.clicktale.net/WRb6.js'%20type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">

if(typeof ClickTaleUploadPage=='function') {
ClickTaleUploadPage('<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>','</html>');}
if(typeof ClickTale=='function') ClickTale(xxxx,y,"wwwzzz");
</script>

]]>
</script>
</scripts>
</source>

'''IMPORTANT NOTE! This is how the code looks like in a text editor. In a browser, "&lt;" will be converted to "<" and "&gt;" will become ">"'''

'''IMPORTANT NOTE! This code sample relates to http tracking code only! for tracking code which can record both http and https pages you should first make sure your plan offers the ability to record https pages (check if the option is available in the tracking code generation page), then generate SSL/https compliant code.'''

'''The /includes/application_bottom.php should look like:'''

<source lang="php">
<?php
require_once("../ClickTale/ClickTaleBottom.php");

/**
* application_bottom.php
* Common actions carried out at the ...........
</source>

'''The /includes/application_top.php should look like:'''

<source lang="php">
<?php
require_once("../ClickTale/ClickTaleTop.php");
/**
* application_top.php Common actions carried out at the start of each page invocation.
*............
</source>

[[Category:Plugins and Integrations]]

X-Cart integration

2011-10-09T13:57:47Z

Shmuls:

{{SMB}}
Websites which use the shopping cart software X-Cart can integrate ClickTale by following these steps:
#Install the ClickTale [[PHP integration module]] under the root X-Cart directory.
#Download and extract clicktale.php from [http://forum.clicktale.net/download/file.php?id=43 here], and save it to the X-Cart root directory.
#Modify the smarty.php file located in the X-Cart root directory by adding the following to the end of the file:
<source lang="php"><?php require_once ($xcart_dir . "/clicktale.php"); ?></source>
'''Please note: You need to make sure there are no trailing spaces after the closing > as this might prevent x-cart from functioning.'''
[[Category:Plugins and Integrations]]

WordPress integration

2011-10-09T13:57:40Z

Shmuls:

{{SMB}}
There are several simple ways to get ClickTale working with your WordPress blog or site, the easiest being with our pre-build WordPress plugin.

==WordPress plugin==

This is a plugin for self hosted WordPress blogs that allows easy addition and change of the ClickTale script. As well as recording your visitors, this plugin also automatically tags their recordings with [[events]] based on their behavior on the page.
===Automated Event tags===
This plugin will add the following [[event]] tags to your visitor recordings:
*Searches using the "Search" button.
*Additions of comments.
*Clicks on the RSS or Comments-RSS link.
This plugin has been tested on all versions of Wordpress up to 3.0.5. if you find it incompatible with your version of WordPress, please let us know about it in our [http://forum.clicktale.net/viewtopic.php?f=5&t=317 forum].

===Installation Instructions===
#Download the plugin from Wordpress plugin directory (http://wordpress.org/extend/plugins/clicktale/).
#Upload to your /wp-contents/plugins/ directory.
#Go to the admin interface in your WordPress web site (~/wp-admin/) and choose the Plugins tab.
#Find the ClickTale Plugin there and activate it.
#A new sub-tab called "ClickTale Options" will appear, click on it.
#Paste your top and bottom tracking scripts in the appropriate places, then press "Update Options" button (the tracking scripts are available in your ClickTale account).
That's all! You have set up ClickTale on your WordPress blog.

==Manual Installation==
Other methods of installation include the 2 following methods listed below. Please note they '''do not work''' for wordpress.com hosted blogs.
===Method 1===
If you have access to the administration panel of your wordpress blog:
*Go to "presentation" then "theme editor".
*Select the header.php (Header) file.
*Add the first portion of code after <body>, update, then open footer.php (Footer) and copy second part before</body> and update.
===Method 2===
*Go to the folder where your template is located (For example wp-content\themes\default\).
*Open header.php in a text editor.
*Locate the <body> tag and paste the two parts of the code generated by ClickTale right after it.
[[Category:Plugins and Integrations]]

Webtrends Analytics integration

2011-10-09T13:57:31Z

Shmuls:

'''Please Note: Webtrends integrations are exclusively available to ClickTale Enterprise customers. If you have are questions regarding access to this service, please contact sales at http://www.clicktale.com/contact/contact_us.'''
__TOC__
==Webtrends Analytics Integration==
The ClickTale and Webtrends Analytics integration enables Webtrends customers to gain more value from their existing business investments and attain a more accurate and visual representation of their online users. No need to start from scratch, simply enhance your already collected data with qualitative information of individual visitors and user groups.

Drill down into individual visitor browsing sessions, understand visitors’ actual online behavior, as reflected in their mouse movements, scrolls, clicks and keystrokes, as well as aggregated reports of customer activity inside specific web pages. Pinpoint specific problematic pages, form fields, and usability obstacles.
===How the integration works===
The simple integration process involves two steps:
#Simply make a slight change in the Webtrends code on web pages you wish to record.
#Add a definition to Webtrends administrative console, allowing each ClickTale user ID to be recorded. You can then use Webtrends as usual and easily copy/paste the relevant ClickTale IDs to find specific recordings or to use in aggregate ClickTale reports.
===Key advantages===
*The integrated solution allows e-businesses to:
**Identify users in Webtrends Analytics and view their recording playback sessions with the ClickTale solution
**Personalize user data with visual representation of visitor behavior
*Leverage your existing investments. Learn more from your already created Webtrends databases, funnels, analytics reports. Once an inconceivable task for site owners with a heavy traffic load, now understand visitor usability at a more personal level.
*Identify users in Webtrends and view their session playback in ClickTale. Watch actual video recordings of anonymous visitors’ browsing sessions to understand how customers successfully convert and why lost visitors drop out. The behavioral search enables you to instantly search and watch only the RELEVANT videos you need. Fix and improve vital business processes in real-time!
*Enjoy ClickTale’s Drill-Down and Segmentation capability on your existing Webtrends reports. Be able to pick and choose some or all of the Visitor IDs you want/need to analyze with ClickTale. Gain complete access to ClickTale’s customer experience analytics products and features, including the ClickTale Heatmap Suite, Form Analytics and Conversion Funnels.

[[Category:Plugins_and_Integrations]]

Webtrends Analytics integration

2011-10-09T13:57:19Z

Shmuls:

{{SMB}}
'''Please Note: Webtrends integrations are exclusively available to ClickTale Enterprise customers. If you have are questions regarding access to this service, please contact sales at http://www.clicktale.com/contact/contact_us.'''
__TOC__
==Webtrends Analytics Integration==
The ClickTale and Webtrends Analytics integration enables Webtrends customers to gain more value from their existing business investments and attain a more accurate and visual representation of their online users. No need to start from scratch, simply enhance your already collected data with qualitative information of individual visitors and user groups.

Drill down into individual visitor browsing sessions, understand visitors’ actual online behavior, as reflected in their mouse movements, scrolls, clicks and keystrokes, as well as aggregated reports of customer activity inside specific web pages. Pinpoint specific problematic pages, form fields, and usability obstacles.
===How the integration works===
The simple integration process involves two steps:
#Simply make a slight change in the Webtrends code on web pages you wish to record.
#Add a definition to Webtrends administrative console, allowing each ClickTale user ID to be recorded. You can then use Webtrends as usual and easily copy/paste the relevant ClickTale IDs to find specific recordings or to use in aggregate ClickTale reports.
===Key advantages===
*The integrated solution allows e-businesses to:
**Identify users in Webtrends Analytics and view their recording playback sessions with the ClickTale solution
**Personalize user data with visual representation of visitor behavior
*Leverage your existing investments. Learn more from your already created Webtrends databases, funnels, analytics reports. Once an inconceivable task for site owners with a heavy traffic load, now understand visitor usability at a more personal level.
*Identify users in Webtrends and view their session playback in ClickTale. Watch actual video recordings of anonymous visitors’ browsing sessions to understand how customers successfully convert and why lost visitors drop out. The behavioral search enables you to instantly search and watch only the RELEVANT videos you need. Fix and improve vital business processes in real-time!
*Enjoy ClickTale’s Drill-Down and Segmentation capability on your existing Webtrends reports. Be able to pick and choose some or all of the Visitor IDs you want/need to analyze with ClickTale. Gain complete access to ClickTale’s customer experience analytics products and features, including the ClickTale Heatmap Suite, Form Analytics and Conversion Funnels.

[[Category:Plugins_and_Integrations]]

Volusion integration

2011-10-09T13:54:15Z

Shmuls:

{{SMB}}
The Volusion integration is based on the [[Classic ASP integration code]] and allows you to record Volusion websites using the [[FetchFromWithCookies]] method.

'''Please note:''' Volusion’s one-page checkout uses JavaScript panels which ClickTale does not support by default. Please visit [[Recording JavaScript]] to enable support for these panels.

Replace the bottom part of your [[tracking code]] with the one of the following to allow ClickTale to better cache the pages of your website:

==https compliant Volusion code==

This code will record https/SSL paes as well as standard pages. This functionality is not available for all plans and will not work unless supported by your current plan.
The FetchFromWithCookies.js file has to be hosted locally in a https location, and its source in the script updated.

<source lang="javascript">

<div id="ClickTaleDiv" style="display: none;"></div>
<script type='text/javascript'>
document.write(unescape("%3Cscript%20src='"+
(document.location.protocol=='https:'?
'https://clicktale.pantherssl.com/':
'http://s.clicktale.net/')+
"WRb.js'%20type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
ClickTaleFetchFromWithCookies.setFromCookie(/^ASPSESSIONID.*/);
ClickTaleFetchFromWithCookies.setFromCookie("CartID5");
ClickTaleFetchFromWithCookies.setFromCookie("History50");

ClickTaleFetchFrom = ClickTaleFetchFromWithCookies.constructFetchFromUrl();
var ClickTaleSSL=1;
if(typeof ClickTale=='function') ClickTale([!YOUR PARAMETERS!]);
</script>
</source>

==Standard Volusion code==

This code cannot record https/SSL pages, so you will not be able to record the checkout page with this code.

<source lang="javascript">

<div id="ClickTaleDiv" style="display: none;"></div>
<script type="text/javascript">
if(document.location.protocol!='https:')
document.write(unescape("%3Cscript%20src='http://s.clicktale.net/WRb.js'%20type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
ClickTaleFetchFromWithCookies.setFromCookie(/^ASPSESSIONID.*/);
ClickTaleFetchFromWithCookies.setFromCookie("CartID5");
ClickTaleFetchFromWithCookies.setFromCookie("History50");

ClickTaleFetchFrom = ClickTaleFetchFromWithCookies.constructFetchFromUrl();

if(typeof ClickTale=='function') ClickTale([!YOUR PARAMETERS!]);
</script>
</source>

[[Category:Plugins and Integrations]]

TypePad integration

2011-10-09T13:54:11Z

Shmuls:

{{SMB}}
Integrating ClickTale with TypePad couldn't be easier:
==Automatic integration==
#Once you have generated your [[tracking code]] for your account, click on the TypePad widget you will see in the right hand panel of the code creation page.
==Manual integration==
#Create a new link TypeList and configure the Notes to display as Text.
#Add an item to the new TypeList and paste the [[tracking code]] into the notes. If your script is composed of two parts, add both; one after the other.
#Add the TypeList to your site at the very bottom of the right-hand sidebar.
That's it!
[[Category:Plugins and Integrations]]

TinyMCE integration

2011-10-09T13:54:05Z

Shmuls:

{{SMB}}
TinyMCE sets a domain limitation of the document in the frame in a way that will prevent it from being accessed by ClickTale. The following code will work around that issue.
==Instructions==
Add this code before including the "tiny_mce/tiny_mce_src.js" file in your HTML.
<source lang="javascript"><script type="text/javascript">
try
{
if(!parent || !parent.WebPlayer) // if there is no WebPlayer or if the above frame is not accessible
throw false;
var tinyMCEPreInit = {base : ''+location.hostname};
} catch(e) {}
</script>
</source>

[[Category:Plugins_and_Integrations]]

Shopify integration

2011-10-09T13:53:12Z

Shmuls:

{{SMB}}
'''Jamie from [http://www.charlestoncreative.com/ Charleston Creative] created this method for getting ClickTale to work on shopify pages.'''

You need to have your two part ClickTale [[tracking code]]. If you only want this for the index page then your code should look something like this:
<source lang="javascript">
{% if template == 'index' %}

{% endif %}

</head>
<body>

SITE CONTENT

{% if template == 'index' %}

{% endif %}

</body>
</html>
</source>
Read more on the original [http://forums.shopify.com/categories/2/posts/38778 forum post].

[[Category:Plugins and Integrations]]

Ruby on Rails integration module

2011-10-09T13:50:11Z

Shmuls:

{{SMB}}
Michael Mazyar from [http://blog.astrails.com/ Astrails], an Israeli web consultancy that specializes in Rails web development, released this implementation of an [[integration module]] between ClickTale and Rails.

The implementation allows complex pages of a Rails website to be recorded and cached correctly by the ClickTale service. Complex pages are ones that are dependant on session state or which process POST requests. Those methods often affect pages behind a login, shopping carts and checkout pages.
__TOC__
==Installation==
<ol>
<li>Download the plugin from [http://github.com/astrails/clicktale/tree/master github].</li>
<li>Install the plugin:</li>
<pre>./script/plugin install git://github.com/astrails/clicktale.git</pre>
<li>Replace project_id, ratio and param in the autogenerated config/clicktale.yml with values from your ClickTale tracking code.</li>
<li>Add ClickTale partials into layout inside the ‘body’ tag:</li>
<pre>
<body>
<%= clicktale_top %>
...
<%= yield %>
...
<%= clicktale_bottom %>
</body>
</pre>
<li>Add a cron job (crontab -e) that will take care of the old cached files</li>
<pre>*/30 * * * * find /path/to/your/application/public/clicktale/ -type f -mmin +30 -exec rm {} \;</pre>
</ol>
'''Note:''' The plugin works by leveraging rails caching mechanism, which is by default only enabled in production environment. To enable the plugin in the development environment do the following:
*set enabled=true in config/clicktale.yml (development section)
*set config.action_controller.perform_caching=true in config/environments/development.rb
==Options==
*Add ClickTale method on class level in your controller to change the ClickTale project for specific controller
<pre>
class UsersController < ApplicationController
clicktale :project_id => ANOTHER_PROJECT_ID
...
end
</pre>
*Call the same method to tag this controller’s actions in clicktale records
<pre>
class UsersController < ApplicationController
clicktale :project_id => ANOTHER_PROJECT_ID, :tag => :specific_tag
...
end
</pre>
*You can call the same method with same parameters on the action level to control project id and tag for this specific action
==Feedback==
Please submit issues to [http://github.com/astrails/clicktale/issues github].
[[Category:Plugins_and_Integrations]]

ProStores SSML integration

2011-10-09T13:50:03Z

Shmuls:

{{SMB}}
SSML stands for Store Sense Markup Language and is the proprietary markup for the eBay ProStores e-commerce system. As ProStores runs on a divided header/footer template system, Headers and footers are loaded on each page with the content loaded between them, so you can run into security certificate warnings on the checkout pages if your links aren't relative or secure (https) on those pages.

This fix, by a user in our forum called ''forsports'', uses SSML conditional statements to load the non-secure version on non-secure pages and the secure version on secure pages.

===ClickTale Top Section===
<source lang="html4strict">

<script type="text/javascript"> var WRInitTime=(new Date()).getTime();
</script>

</source>

===ClickTale Bottom Section===
<source lang="javascript"><ss:if test="$request.getScheme() == 'http'">

<div id="ClickTaleDiv" style="display: none;"></div>
<script src="http://s.clicktale.net/WRb.js" type="text/javascript"></script>
<script type="text/javascript">
if(typeof ClickTale=='function') ClickTale([!your parameters!]);
</script>

<ss:else/>

<div id="ClickTaleDiv" style="display: none;"></div>
<script type='text/javascript'>
document.write(unescape("%3Cscript src='"+((document.location.protocol=='https:') ? 'https://clicktale.pantherssl.com/' : 'http://s.clicktale.net/')+"WRb.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
var ClickTaleSSL=1;
if(typeof ClickTale=='function') ClickTale([!your parameters!]);
</script>

</ss:if></source>

[[Category:Plugins_and_Integrations]]

POST pages

2011-10-09T13:49:49Z

Shmuls:

{{SMB}}
A POST page is a page that processes the submit of a HTML form. Not all HTML forms submit to a POST page, some submit to a GET page (where field data is sent in the URL).<br>
'''If you can change your form to submit the data via GET then you can easily fix this issue without needing the fix below.'''
__TOC__
==How ClickTale handles POST pages==
By default ClickTale doesn't support caching HTML content of POST pages. This is by design to prevent "double submits" of your forms and to eliminate potential side-effects.

Normally what would happen is that ClickTale will record all the client side activity correctly but the caching of the HTML content will fail. As a result you might see one of the following symptoms:
*An error dialog during playback, there will usually be a yellow exclamation icon near the row of the recording.
*A blank playback frame.
*Wrong content shown in playback frame.
This happens because when ClickTale attempts to cache the page it will do a regular GET request to your server, expecting to get an answer. You, however, will be expecting the parameters from the form and will be willing to take some action such as adding something to the database or sending an email.
==Possible solutions==
There are several possible solutions:
*The easiest solution is to process the POST and then redirect to a GET URL.
*Redirect the user to another page once POST processing ends. That page will be a GET page so no caching of POST pages will be required.
*Install one of our ClickTale [[:Category:Plugins and Integrations|Integration Modules]]. Currently there are ones for [[ASP.NET]], [[PHP]], [[J2EE Integration Module]] and [[Ruby On Rails]] (ROR).
*Change your FORM to use the GET method. This is only good if your form does no processing with side effects, such as creating records, accounts or sending emails. This is only good for forms with small amount of simple fields, as field values will be shown in the URL
*Change your POST processing page to redirect to a GET page once processing is done. This is instead of rendering the success/error information in the POST processing page. Great option for "thank you for..." pages, etc'.
*Create a static HTML page that contains the same content of the POST page and use the [[ClickTaleFetchFrom]] instruction to make ClickTale fetch the page from that location. Minor differences between the static HTML page and the actual content are ok.
*Use the [[ClickTaleUploadPage]] API method. This is good for short pages.
*Implement custom handling in your code to support your specific design (See below).

==Implement custom handling in your code - an example==
We can modify our POST script to support caching as follows. This is the most efficient method but will also require the most effort to implement. We will continue this tutorial by explaining how to implement this option.

On our public site (www.clicktale.com) we have a signup form. When people submit the form it is sent as a POST request to us. We have an ASP.NET page that processes this form. All examples will be in ASP.NET but you can easily adapt them to your own needs.
The back-end script is called signup.aspx and after finishing the processing it can return 5 different responses to the visitor.
We will:
#Extend the script to return any of the possible responses based on a GET parameter without doing any processing.
#Extend the script to instruct ClickTale which version of the page to request based on what was returned to the user.

Prior to this, the script was checking if the request is a POST request and doing some processing. If the request was not a POST request it would redirect to the original form. We will add an additional case
<source lang="asp"> else if(Request.QueryString["p"]!=null) // if this is a caching request from ClickTale
{
ErrorPanel.Visible = false; // hide all forms
switch(Request.QueryString["p"])
{
case "s":
SuccessPanel.Visible = true;
break;
case "e":
ErrorPanel.Visible = true;
break;
case "o":
OpenPanel.Visible = true;
break;
case "i":
InvitedPanel.Visible = true;
break;
case "c":
ConvertedPanel.Visible = true;
break;
}
}</source>
so if the query string parameter "p" is present then we will do some rendering. "p" just tells us which of the five panels to show. You may use more than one parameter or use different parameter names if you would like. For each value of "p" we return a different response by making one panel visible.

Now we need to tell ClickTale to request a URL of your script with the right parameter for each of those cases.
Normally our panels look like this:
<source lang="asp"> <asp:Panel ID="SuccessPanel" runat="server" Visible="false">
<h4>Thank you! Your data has been registered.</h4>
<br />
We will send an invitation to the email address your specified as soon as we can accommodate you.<br />
Meanwhile, why not go to our <a href="http://blog.clicktale.com/">blog</a> now and read more about what we do?<br />
</asp:Panel></source>
so we will modify then to include an assignment of a custom caching URL (a property from the API)
<source lang="asp"> <asp:Panel ID="SuccessPanel" runat="server" Visible="false">
<h4>Thank you! Your data has been registered.</h4>
<br />
We will send an invitation to the email address your specified as soon as we can accommodate you.<br />
Meanwhile, why not go to our <a href="http://blog.clicktale.com/">blog</a> now and read more about what we do?<br />
<script type="text/javascript">
ClickTaleFetchFrom="<% =Request.Url.ToString() %>?p=s";
</script>
</asp:Panel></source>
We do this for each of the panels.<br>
'''Important: ClickTale external script file (WR[ver].js) should be included prior to the assignment and the call to ClickTale(...) function should be included after the assignment.'''

After those two modifications, the visitor will get the response from the back-end script and instruct ClickTale to do the caching from the correct location. ClickTale will then request the page from the alternate location and your server will respond with the correct content. Now your playback will show the correct data.
[[Category:Plugins and Integrations]]

PHP integration module

2011-10-09T13:49:44Z

Shmuls:

{{SMB}}
This [[Integration module]] is for [http://en.wikipedia.org/wiki/PHP PHP] sites using dynamic content which changes for each user independently. For example, shopping carts are often such pages.
It will allow you to store the exact version that the user saw and allow our fetching bot to collect that version so it will be available to you in the playback of visitors visits and other reports.
The PHP Integration Module is the next generation of the PHP Integration Code and adds further support to cases that were not previously covered, such as POST processing pages.

The module is PHP5 code, provided with full sources, that allows better integration of a PHP site with ClickTale by enabling accurate caching of the HTML that is sent to the visitor in ClickTale recorded pageviews.
__TOC__

'''If you are unable to install a binary module on your site, or if you have an old version of PHP (prior to Version 5), please use the [[FetchFromWithCookies]] method instead.'''

==Integration with third-party applications==
Please use the following integration methods if you are using one of these applications on your website.
*[[Drupal integration]]
*[[Joomla! module]]
*[[Magento integration module]]
*[[X-Cart integration]]
*[[Zend Framework integration]]

==Installation Guide==
<ol>
<li>The module itself can be found [http://www.clicktale.com/integration/ClickTalePHPIntegrationModule_latest.zip here].</li>
<li>Remove the existing ClickTale code and/or disable other integration methods (for example, PHP integration code - which supports session state only.)</li>
<li>Extract the archive to a directory named "ClickTale" in your website. Do not to create a directory named "ClickTalePHPIntegrationModule_X.X" in it. Simply place the files in ".../ClickTale/".</li>
<li>Generate the ClickTale tracking code you want to use in your pages (or locate your already generated code).</li>
<li>Copy and paste that code (from previous step) into the appropriate parts in ClickTale/ClickTaleScripts.xml file.</li>
<li>Add
<source lang="javascript">
ClickTaleFetchFrom="%FetchFromUrl%";
</source>
Just before the line
<source lang="javascript">
if(typeof ClickTale=='function') ClickTale([your ClickTale parameters])
</source>
'''Please note: you do not need to change "%FetchFromUrl%" to a specific URL. It will be replaced automatically during the rendering process, with a value dependent on the page being recorded.'''<br>
Your xml file should now look like this:
<source lang="javascript">
<?xml version="1.0" encoding="utf-8" ?>
<scripts>
<script name="Top" DoNotReplaceCondition = "">
<![CDATA[

<script type="text/javascript">
var WRInitTime=(new Date()).getTime();
</script>
]]>
</script>
<script name="Bottom" DoNotReplaceCondition="" InsertBefore="|</body>">
<![CDATA[
<div id="ClickTaleDiv" style="display: none;"></div>
<script type="text/javascript">
if(document.location.protocol!='https:')
document.write(unescape("%3Cscript src='http://s.clicktale.net/WRb.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
ClickTaleFetchFrom="%FetchFromUrl%";
if(typeof ClickTale=='function') ClickTale([Your ClickTale parameters]);
</script>
]]>
</script>
</scripts>
</source>
'''IMPORTANT NOTE! This is how the code looks like in a text editor. In a browser, "&lt;" will be converted to "<" and "&gt;" will become ">"'''

'''IMPORTANT NOTE! This code sample relates to http tracking code only! for tracking code which can record both http and https pages you should first make sure your plan offers the ability to record https pages (check if the option is available in the tracking code generation page), then generate SSL/https compliant code and use it in step 6 instead (you should still add the [[ClickTaleFetchFrom]] command, right before the line var ClickTaleSSL=1; or between 2 lines var ClickTaleSSL=1; and ClickTale([your ClickTale parameters]); ).'''</li>
<li>Every page you wish to be recorded should contain the following PHP code:
<source lang="php">
<?php
require_once("[physical_path_to_clicktale_dir_here]\ClickTale\ClickTaleTop.php");
?>
</source>
at the top ('''before any content is sent''', ie. before the Doctype and opening html tag, this is to ensure the entire page is captured including the <head> sections.) and
<source lang="php">
<?php
require_once("[physical_path_to_clicktale_dir_here]\ClickTale\ClickTaleBottom.php");
?>
</source>
at the bottom ('''after all content has been sent''', including the closing html tag).
For example, with Joomla! you can try adding these lines to the top and bottom of the file index.php (in Joomla's root), this will add recording to all pages. The log error "The output buffer callback does not exist in the buffers stack" can be indicative of an issue with the code injection process/snippet position.
'''Do not forget to replace [physical_path_to_clicktale_dir_here] with the relevant folder.'''</li>
<li>Create two directories named "Cache" and "Logs" under the ClickTale directory. Make sure they have the proper writing permissions, for instance:<br/>
*If you are using Apache with mod_php then the Cache and Log directories must be writable by Apache.<br/>
*If the PHP is executed by some other means (CGI for instance), it's possible that it is executed as a different user than the webserver, so in that case it might be simpler to just make the permissions for those directories 777.<br/>
*For windows machines, the directories should be writable by the webserver.
</li>
</ol>

Optionally: see [[Selective recordings#Selective recording via URL parameter|here]] to disable or enable yourself from being recorded. Apply this to everyone who is working with you on the site otherwise they will use recording quota, or enable this for testing to make sure all is working correctly.
===Troubleshooting===
After the files are copied you can navigate your browser to '''<nowiki>http://yoursite/ClickTale/Install/index.php</nowiki>''' to view some helpful information regarding the caching and other configurations.
You can delete the Install folder once you don't need the troubleshooting/debugging assistance it provides. Deleting it prevents some of your configuration setting from being publicly available to others.

==Configuring the caching provider==
The module caches the content of the pages so it can later provide the content to ClickTale servers for processing. This caching requires some persistent storage and so different caching providers are supported.
The default caching provider is the file system ("cache" folder), it is slower than other methods.
It is recommended to use the MySQLMemory provider. To do so you will need a valid connection to a MySQL database.
There is also the APC module which requires installation. More details about APC can be found [http://php.net/apc here].

After installing APC or MySQL, you can enable its provider by editing config.php file, and changing:
<source lang="php">$config['CacheProvider'] = "FileSystem";</source>
to
<source lang="php">$config['CacheProvider'] = "MySQLMemory";</source>
or
<source lang="php">$config['CacheProvider'] = "APC";</source>

'''Note: The file-system provider will need write access rights to the "ClickTale/Cache" folder. On the other hand, APC and MySQLMemory will use memory for storage.'''
==Caching provider settings==
====FileSystem====
*$config['DeleteAfterPull'] = (true / false)
**If true, the cached page is deleted after clicktale fetches it from your site
*$config['CacheLocation'] = (path to directory)
**Where the cache files should be saved. This directory should be writable (you can use the Install/index.php to check write permissions)
*$config['MaxFolderSize'] = (integer)
**The size of the cache dir in MegaBytes. If the cache gets larger than that, stale caches are removed

====MySQLMemory====
*$config['DeleteAfterPull'] = (true / false)
**See FileSystem
*$config['CacheLocation'] = (mysql url)
**url of the form <nowiki>http://<db username>:<db password>@<host of mysql>:<port of mysql>/<database to use>.<memory table name to use></nowiki>
*$config['MaxCachedSeconds'] = (integer)
**Will only keep pages in cache for up to MaxCachedSeconds seconds. This will make sure that your cache storage will only take a small amount of memory.
====APC====
*$config['DeleteAfterPull'] = (true / false)
**See FileSystem
*$config['MaxCachedSeconds'] = (integer)
**See MySQLMemory
===Use With "Expires" Header And Enable Reuse Of Cached Pages===
Some websites use "cache-control" and "expires" headers to cache pages on the client. This improves performance but may be problematic when used with our module. Pages are removed from the module's cache right after they are being accessed (for security and performance reasons). So, if a visitor browses a page more than once without refreshing the content from the server (usually a result of using the back button), ClickTaleCache.php will be called several times with the same token. This will cause a cache miss for any request beyond the first one.
To overcome this problem, it is possible to use the DeleteAfterPull="false" parameter in the configuration. This will disable the removal of cached pages when ClickTaleCache.php is called. Cached data will be removed after MaxCachedPages="???" new pages are cached, so you might want to extend this parameter as well to allow sufficient traffic between the first pageview and the next (duplicate pageview).
Additionally, you can change your HTTP cache control to "no-cache" which will might be more correct for your application logic in the first place.
Currently, this feature is not available when caching to databases.
==Troubleshooting and debugging==
The module's log files are located in: "ClickTale/Logs/Log_{0}.txt", where {0} is the log file's date. <br>
Setting: '''$config['AllowDebug'] = true;''' in config.php allows for more detailed log files. Please set this if requested by Support.

==License==
The module is subject to a permissive license for ClickTale users. Please see license.txt in the archive for more information.
==Q&A==
:'''Q: Are cached pages protected from access by third parties?'''<br>
:A: Yes, several layers of protection are in place. Only certain IPs are allowed to request the cached pages (IPs of ClickTale servers) and only processes which already have access to the page have the secret token required to request the cached content.

:'''Q: Is it possible to inject the script in other places rather than after/before body tags?'''<br>
:A: Yes. By default the top script is injected after <body> and the bottom before </body>, but this can be changed by adding a InsertAfter attribute to the script[name="Top"] element or adding a InsertBefore attribute to the script[name="Bottom"] element, both are regular expressions.

:'''Q: Some of my pages already have the ClickTale script, I do not want the script appear twice.'''<br>
:A: You should either remove the script from those pages and let the module handle the insertion or you should use DoNotReplaceCondition. See the code step 2 for an example. The default script in Step 2 is already configured to prevent double inclusion.

:'''Q: After installing the module, I tried to watch a recording but I got the following notice instead: "Request from an unauthorized IP." . What should I do?'''<br>
:A: This could be a misconfiguration, a change in our IP addresses or a hacking attempt. Please contact us so we can investigate this further.

:'''Q: I have installed the module but I don't see the tracking code in the source of the page. What is wrong?'''<br>
:A: The module will only inject the code for visitors who are classified as "to-record" (have WRUID cookie with non-zero value) or for those who are not classified (no WRUID cookie). Visitors who are classified as "not-to-record" will get no code.

:'''Q: I'm using a proxy server for my website - what steps should I take to record properly?'''<br>
:A: Move the IP restriction rule to the proxy and set the IP in config.php (located in the php integration module directory) to the IP of the proxy.

==Using a proxy server==
If you have a proxy, whenever our servers will try to get the cache they will appear to have the address of the proxy which is not allowed by default.
To fix this, you should set the IP address of the proxy to the $config['AllowedAddresses'] value in the module's config.php file and set a rule with your proxy saying that only our servers IP range can access the ClickTaleCache.php file.
Our servers IP range is: 75.125.82.64/26,50.97.162.64/26 (''stands for 75.125.82.64 - 75.125.82.127 and 50.97.162.64 - 50.97.162.127'').

==Reference==
[[ASP.NET integration module]] - Good read as some configuration schema is shared.
[http://www.hostgatorcouponsreview.com HostGator Coupons]
[http://www.thegrizasonline.com/ Business Solutions & Tools]
[[Category:Plugins and Integrations]]

PHP integration code

2011-10-09T13:49:39Z

Shmuls:

{{SMB}}
<center><big>'''If possible, use the [[PHP integration module]] instead. It provides better integration with our service.<br>
The only reason to use this code is if you are unable to install a binary module on your site.'''</big></center>

This is an up to date version of the integration code which is based on work done by Jake from [http://www.supportourribbons.com/ Support Our Ribbons].
==Instructions==
If your site uses cookie-based sessions, you may have noticed that ClickTale is unaware of any session-based stuff that's happening. So this is a little function for overriding the URL that ClickTale fetches from so it is sure to include the current session id. It's intended for people using PHP's built-in session functions (e.g. $_SESSION).

You'll notice that we include the ClickTale source locally; if you like you can save the code in an external include file.
You will need to modify the parameters of the ClickTale() function to reflect the parameters of your account as well as update the path to the recording script. To fill-in the missing information compare the code below with the code that was generated for you by the "Script Generator".
<pre>
<?
function get_clicktale_footer() {
$current_url = get_base_url();
$sid = session_id() ;
//if the session id is set, and not included in the current URL,
//append it to the current URL
if( !strstr( $current_url, session_name().'=$sid' ) && !empty($sid) ) {
$fetch_from = "ClickTaleFetchFrom='$current_url" ;
if( strstr( $current_url, '?' ) )
$fetch_from .= "&" ;
else
$fetch_from .= "?" ;
$fetch_from .= session_name()."=$sid';" ;
}
else
$fetch_from = "";

return "
<div id='ClickTale' style='display: none;'></div>
<script src='[!YOUR CLICKTALE PATH!]/WRb.js' type='text/javascript'></script>
<script type='text/javascript'>
//This is where everything pays off.
//Update the URL clicktale fetches from:
if(typeof ClickTale=='function') {
$fetch_from
ClickTale([!YOUR CLICKTALE PARAMETERS!]);
}
</script>
" ; // update your values here based on the script generated.
// Note the parameters to ClickTale call and the url. Keep other syntax and the line "$fetch_from" as-is.
}

function get_base_url() {
if( $_SERVER['SERVER_PORT'] == "443" )
$abs_path = "https://" ;
else
$abs_path = "http://" ;

$abs_path .= $_SERVER['HTTP_HOST'] . $_SERVER['SCRIPT_NAME']; //$_SERVER["REQUEST_URI"] ;
if( !empty($_SERVER['QUERY_STRING']) )
$abs_path .= '?' . $_SERVER['QUERY_STRING'];

return $abs_path ;
}

function get_clicktale_header() {
return "
<script type='text/javascript'>
var WRInitTime=(new Date()).getTime();
</script>
" ;
}

//echo get_clicktale_header(); // call after <BODY>
//echo get_clicktale_footer(); // call before </BODY>
?></pre>

What is left now is to echo the result of the PHP functions get_clicktale_header() and get_clicktale_footer() near your body and /body tags to finish the integration.

If you have generated a SSL code with the generator you will need to do some extra copy-pasting to make your include.

[[Category:Plugins_and_Integrations]]

Offline recordings

2011-10-09T13:48:38Z

Shmuls:

{{SMB}}
Offline pages are pages which are not accessible using an internet connection from outside of your organization. Pages which merely require [[HTTPS|user authentication]], i.e. a username and password, do not count as offline. Examples of offline pages are intranet pages or pages in a website's development environment.

Normally ClickTale servers access the pages that are recorded in order to capture the content of the page, later to be used in reports and playback. When a page is inaccessible, the content can't be captured and playback will fail.

'''Please note:''' Due to restrictions on domain usage, free subscribers cannot record from a ‘localhost’ domain name(or 127.0.0.1). You can setup a different name for your test host, other that ‘localhost’ via your HOSTS file(xyz "local IP address") or by using the machines IP address in the browser.

These pages can be recorded using one of the following three methods:

==Method 1==
You can allow our servers access to your site or to specific pages by whitelisting our servers' IP ranges, which are '''75.125.82.64/26 and 50.97.162.64/26''', and opening a network connection(normally port 80/443) for the ClickTale bot from these IP's to the sites ports on your server(eg. 8080).

If you are using the [[PHP]] or [[ASP.NET]] integration modules then you only need to allow access to the URL of the integration module (ClickTaleCache.php and ClickTaleCache.ashx <nowiki>[virtual]</nowiki> respectively) on your server to our IP range.

Each client would also be required to be able to access the ClickTale servers(on standard ports).

This may involve firewall and/or router/NAT configuration to ensure the passage of traffic/packets.

This is especially relevant to corporate Intranet environments and non-public/local development setups.

==Method 2==
You can use the [[ClickTaleUploadPage]] API command. Please note that this command is not suitable for production environment (online) and will hurt customer experience(slower page load times due to overhead). If you are using one of the integration modules use [[ClickTaleUploadPage]] in an offline environment and [[ClickTaleFetchFrom]] code line in an online environment.
If you are NOT using one of the integration modules use [[ClickTaleUploadPage]] in an offline environment and remove it in an online environment.

To use [[ClickTaleUploadPage]] edit the ClickTale code at the bottom of the page to read:
<source lang="html4strict"><script type="text/javascript"></source>
'''<source lang="html4strict">
if(typeof ClickTaleUploadPage=='function') {
ClickTaleUploadPage('<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>','</html>');}</source>'''
<source lang="html4strict">if(typeof ClickTale=='function') ClickTale(xxxx,y,"www0z");
</script></source>

==Method 3==
If (and only if) your development environment is identical to your live one, you may use the [[ClickTaleFetchFrom]] command to direct to it.
To do so, add the following line right before the call to the ClickTale() function:
<source lang="javascript">
ClickTaleFetchFrom=unescape(location.protocol+"%2f%2f"+"[LIVE_DOMAIN_NAME]"+location.pathname+location.search);
</source>
And replace [LIVE_DOMAIN_NAME] with the actual domain name.

'''Please note: this method will require you to check both of these domains in the "manage domains" section of your account.'''

[[Category:Plugins and Integrations]]

MyBlogLog integration

2011-10-09T13:48:25Z

Shmuls:

{{SMB}}
[http://www.mybloglog.com/ MyBlogLog] allows people to identify themselves by their MyBlogLog icons and broadcast their presence on websites and blogs. Each MyBlogLog member has a public profile.

This mashup will allow you to track MyBlogLog (MBL) members who visit your site and add a little MyBlogLog icon next to their name on ClickTale's 'visitors' page. You can then click the icon to go directly to their profile.

The ClickTale/MyBlogLog mashup is a great way to get to know your visitors.

'''Your site doesn't need to be registered with MBL to use it.'''
==Instructions==
<ol>
<li>Add
<source lang="html4strict"><script src="http://s.clicktale.net/ct_mbl.js" type="text/javascript"></script></source>
after the line that looks like
<source lang="html4strict"><script src="http://s.clicktale.net/WRa.js" type="text/javascript"></script></source>
in the existing ClickTale script on you pages.</li>
<li>Add
<source lang="javascript">ctSaveMBLVisitor();</source>
after the line that reads
<source lang="javascript">ClickTale([your project ID],[your ratio]);</source></li>
</ol>
===For example===
Before
<source lang="html4strict">
<div id="ClickTale" style="display: none;"></div>
<script src="http://s.clicktale.net/WRa.js" type="text/javascript"></script>
<script type="text/javascript">
if(typeof ClickTale=='function')
{
ClickTale([your project ID],[your ratio]);
}
</script>
</source>
After
<source lang="html4strict">
<div id="ClickTale" style="display: none;"></div>
<script src="http://s.clicktale.net/WRa.js" type="text/javascript"></script>
<script src="http://s.clicktale.net/ct_mbl.js" type="text/javascript"></script>
<script type="text/javascript">
if(typeof ClickTale=='function')
{
ClickTale([your project ID],[your ratio]);
ctSaveMBLVisitor();
}
</script>
</source>

Note: If you already use the MBL widget to display recent readers, make sure to include the widget before including the bottom ClickTale script.

[[Category:Plugins and Integrations]]

Magento integration module

2011-10-09T13:48:10Z

Shmuls:

{{SMB}}
The Magento integration module will allow ClickTale to properly record your customers. The module caches complete versions of each and every pageview as it is delivered to the customer. No matter what version of your site visitors see, ClickTale Visitor Playbacks will show you the exact content as seen and interacted with by your visitors.

The module is PHP5 code, provided with full sources, that allows better integration of a Magento eCommerce PHP site with ClickTale by enabling accurate caching of the HTML that is sent to the visitor in ClickTale recorded pageviews. Be sure that your host supports both these, as well as the system requirements of Magento.
==License==
The module is subject to a permissive license for ClickTale users. Please see license.txt in the archive for more information.
==Installation Guide==
<ol>
<li>Download the module [http://www.clicktale.com/Integration/ClickTaleMagentoIntegrationModule_latest.zip here].</li>
<li>Unzip the package to your Magento installation directory (sub-directories named app and lib should already be present there). (Once unzipped you should have a directory named lib/ClickTale/... )</li>
<li>Make sure to create lib/ClickTale/Logs and lib/ClickTale/Cache directories (if they do not already exist) and make sure they have writing permission (CHMOD 777)</li>
<li>Generate the ClickTale tracking code you want to use in your pages (or locate your already generated code).</li>
<li>Copy and paste that code (from previous step) into the appropriate parts in lib/ClickTale/ClickTaleScripts.xml file.</li>
<li>Add
<source lang="javascript">
ClickTaleFetchFrom="%FetchFromUrl%";
</source>
Just before the line
<source lang="javascript">
if(typeof ClickTale=='function') ClickTale([your ClickTale parameters])
</source>
'''Please note: you do not need to change "%FetchFromUrl%" to a specific URL. It will be replaced automatically during the rendering process, with a value dependent on the page being recorded.'''<br>
Your xml file should now look like this:
<source lang="javascript">
<?xml version="1.0" encoding="utf-8" ?>
<scripts>
<script name="Top" DoNotReplaceCondition = "">
<![CDATA[

<script type="text/javascript">
var WRInitTime=(new Date()).getTime();
</script>
]]>
</script>
<script name="Bottom" DoNotReplaceCondition="" InsertBefore="|</body>">
<![CDATA[
<div id="ClickTaleDiv" style="display: none;"></div>
<script type="text/javascript">
if(document.location.protocol!='https:')
document.write(unescape("%3Cscript src='http://s.clicktale.net/WRb.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
ClickTaleFetchFrom="%FetchFromUrl%";
if(typeof ClickTale=='function') ClickTale([Your ClickTale parameters]);
</script>
]]>
</script>
</scripts>
</source>
'''IMPORTANT NOTE! This is how the code looks like in a text editor. In a browser, "&lt;" will be converted to "<" and "&gt;" will become ">"'''

'''IMPORTANT NOTE! This code sample relates to http tracking code only. For tracking code which can record both http and https pages you should first make sure your plan offers the ability to record https pages (check if the option is available in the tracking code generation page), then generate SSL/https compliant code and use it in step 5 instead, see below for an example'''</li>

<source lang="javascript">
<?xml version="1.0" encoding="utf-8" ?>
<scripts>
<script name="Top" DoNotReplaceCondition = "">
<![CDATA[

<script type="text/javascript">
var WRInitTime=(new Date()).getTime();
</script>
]]>
</script>
<script name="Bottom" DoNotReplaceCondition="" InsertBefore="|</body>">
<![CDATA[
<div id="ClickTaleDiv" style="display: none;"></div>
<script type='text/javascript'>
document.write(unescape("%3Cscript%20src='"+
(document.location.protocol=='https:'?
'https://clicktale.pantherssl.com/':
'http://s.clicktale.net/')+
"WRb.js'%20type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
ClickTaleFetchFrom="%FetchFromUrl%";
if(typeof ClickTale=='function') ClickTale([Your ClickTale parameters]);
</script>
]]>
</script>
</scripts>
</source>
<br>
<br>
<li> Make sure to "Save configuration" in the Magento admin panel to enable the ClickTale Integration Module. <br>
Go to: System--> Configuration --> Advanced --> Advanced (button) --> click "Save config"</li><br>

</ol>

==Troubleshooting==
Navigate to the page located at www.yourdomain.com/lib/ClickTale/Install/index.php, similar to the PHP Integration module, any items marked red should be corrected for trouble-free recording. Commonly the Cache and Logs folders should be manually given write permissions to the system using CHMOD.

[[Category:Plugins and Integrations]]

'''Please note:''' Magento’s one-page checkout uses JavaScript panels which ClickTale does not support by default. Please visit [[Recording JavaScript]] to enable support for these panels.

Joomla! integration module

2011-10-09T13:48:01Z

Shmuls:

{{SMB}}
This module allows easy addition of ClickTale code into a Joomla! powered website and works in a similar way to the other code/plugins.<br/>
'''Please note:'''<br/>
If you wish to record pages which require visitors to be logged in to view, or pages which have dynamic, user-specific content, or POST pages which have content unavailable via GET, we recommend you incorporate the [[PHP integration module]] instead of using the Joomla! module.
==Installation Instructions for Joomla! 1.0==
#Download ClickTale module from [http://www.clicktale.com/Integration/Joomla/Module%20For%201.0/mod_clicktale.zip here]. Save it somewhere, but do not unzip.
#Log in as administrator.
#From the menu choose "Installers" and then choose "Modules".
#Under "Upload Package File" click browse, and then find the zip directory you saved earlier.
#Click "Upload File & Install"
#After you install the module, choose "Modules" -> "Site Modules" from the menu.
#Locate "ClickTale Module" in the list and click on it.
#In the "Details pane you should set: "Show title" as "No", "Published" as "Yes" and "Position" as "debug".
#In the "Parameters" pane, put your Top and Bottom scripts in the text-boxes.
#Click save (top right of the window).
==Installation Instructions for Joomla 1.5==
#Download ClickTale module from [http://www.clicktale.com/Integration/Joomla/Module%20For%201.5/mod_clicktale.zip here]. Save it somewhere, but do not unzip.
#Log in as administrator.
#From the menu choose "Extensions" and then choose "Install/Uninstall".
#Under "Upload Package File" click browse, and then find the zip directory you saved earlier.
#Click "Upload File & Install"
#After you install the module, go to "Extensions" -> "Module Manager".
#Locate "ClickTale Module" in the list and click on it.
#In the "Details pane you should set: "Show title" as "No", "Enabled" as "Yes" and "Position" as "debug".
#In the "Parameters" pane, put your Top and Bottom scripts in the text-boxes.
#Click save (top right of the window).
===Notes===
*In step 8, if your template does not support the "debug" position, you can choose another one (eg. "footer"). The point is to place the module as low as possible on the webpage.
*Download links for Joomla 1.0 Module and Joomla 1.5 Module are different.
*Joomla 1.0 Module is not optimal since it places both "top" and "bottom" codes at the bottom of the page. We strongly recommend updating your Joomla to the newest version.
==Joomla! Extension==
Created by Josh Guedalia from [http://two-tribes.com Two Tribes]
#Download the extension by Josh Guedalia [http://www.clicktale.com/Integration/Joomla/ClickTale%20Joomla%20module%20by%20Josh%20Guedalia.zip here]
#Go to Extensions>Install/Uninstall browse to clicktale.zip and press 'Upload File & Install', should see 'Install Plugin Success'
#Go to Extensions>Plugin Manager select 'System - Clicktale' to edit plugin.
#Enable plugin (publish) and place tracking code received from clicktale.com in the two parameters - 'top' and 'bottom'
That's it, now every page on the site will have the tracking code added.

[[Category:Plugins and Integrations]]

Template:SMB

2011-10-09T13:47:32Z

Shmuls:

<center><blockquote style="background: white; border: 1px solid rgb(153, 153, 153); padding: 1em; width:88%;">[[Image:Logo.png|30 px|ClickTale Wiki]]<br>'''The instructions on this page are intended for self service and online accounts.<br>Enterprise customers should contact their account managers for integration support.'''</blockquote></center>

JavaScript integration

2011-10-09T13:47:17Z

Shmuls:

{{SMB}}
Some websites use JavaScript dialogs/panels for various purposes, such as for implementing a "more info" panel or a registration form.
If you haven't yet implemented the instructions described here the panel will not open during playback when the trigger is clicked. In addition to that, you won't see Link Analytics data for elements of the panel if the panel is collapsed initially.

'''Please note: Be careful to not mistake JavaScript popups with popups that open in a separate window. Popups that open in a separate window are separate pages and need to have the tracking code added to them.'''
==Enabling dynamic JavaScript activation during playback==
In order to trigger a JavaScript element which is normally triggered by visitor behavior(this includes CSS menus), you need to call the [[ClickTaleExec]] API function within the triggered JavaScript function. [[ClickTaleExec]] will register any action you pass to the function and will execute it during playback, thus enabling you or instance to expand/show the panel/dialog.
===Example 1: Hidden Div Element===
If you have an html page with a button that when clicked shows a DIV html element. This is basically a simple case of a tab control or a DHTML menu. If the button onclick event is:
<source lang="javascript">function ButtonClicked()
{
pane.style.display="block";
}</source>

To record this change alter the function to add a call to ClickTaleExec:
<source lang="javascript">function ButtonClicked()
{
if(typeof ClickTaleExec=='function')
ClickTaleExec("ButtonClicked()");
pane.style.display="block";
}</source>
===Example 2: Dropdown Menu Panels===
This is an example of using the [[ClickTaleExec]] API command to record a dynamic JavaScript menu. Each section of the menu is represented on the page using a list item which calls a JavaScript function entitled toggleMenu(or similar, Inspect Element can be used to find the exact function) when the visitor's mouse hovers over it, this is often found in Magento:
<br>
The menu items are constructed as follows:
<source lang="javascript"><li class="xyz" onmouseout="toggleMenu(this,0)" onmouseover="toggleMenu(this,1)"></source>
And the function itself looks like this:
<source lang="javascript">function toggleMenu(el, over)
{
if (over) {
...
...
}
else {
...
...
}
}</source>
To record the function properly an id attribute should be added to each list item
<source lang="javascript"><li class="xyz" onmouseout="toggleMenu(this,0)" onmouseover="toggleMenu(this,1)" id="menuitem1"></source>
and the function changed to:
<source lang="javascript">function toggleMenu(el, over)
{
if (typeof ClickTaleExec == "function") {
var elId = el.id;
if(elId) {
ClickTaleExec("toggleMenu(document.getElementById('" + elId + "'),"+over+")");
}
}
if (over) {
...
...
}
else {
...
...
}
}</source>
Where "el" is the element, "elId" the ID added to the element, "over" is the toggle action.
Note: As ClickTaleExec is part of an if statement it will only affect the menus during playback.

Note: Some Magento skins will include a 3rd parameter, in this case the following can be used:
<source lang="javascript">ClickTaleExec("toggleMenu(document.getElementById('" + elId + "'),"+over+",”+second+”)");</source>

A quick summary of implementation:
# Right click the element on the page and select "Inspect Element" (in Firefox)
# Identify the function name and parameters that control the movement to be recorded
# Perform the above ClickTaleExec additions to the function
# Add an ID to each menu item if there isn't already one

==Enabling dynamic JavaScript activation during aggregated reports==
This is essential in order to view Link Analytics info and/or Form Analytics info on the elements of the panel(s).
To implement, add the following code to your page after all panels have been loaded:
<source lang="javascript"><script type="text/javascript">
function CTIsPlayback() {
try { return parent && parent.WebPlayer; }
catch(e) { return false; }
}
if(CTIsPlayback() && !parent.P2SIDs)
{
// TODO: add code here to show/expand your panels
}
</script></source>
The code will only be executed when the page is shown as a backdrop of ClickTale's aggregated report.

==A useful function to assist in implementing ClickTaleExec calls==
To use the [[ClickTaleExec]] API command to its full potential you will need to make sure your script can differentiate between three states:
*Regular viewing
*Playback
*Aggregated report
You can do so by including the following function:
<source lang="javascript">function ClickTaleIsIn (testFor) {
var topLocation = top.location;

if(testFor == "recording" && window.location == topLocation) {
return true;
} else if(testFor == "recording" || window.location == topLocation) {
return false;
}

switch(testFor.toLowerCase()) {
case "report":
var fn = arguments.callee;
return fn("scroll-heatmap") || fn("click-heatmap") || fn("form-analytics");
case "scroll-heatmap":
var regex = new RegExp("Heatmap.aspx\?", "i");
return regex.test(topLocation);
case "click-heatmap":
var regex = new RegExp("ClickHeatMap.aspx\?", "i");
return regex.test(topLocation);
case "form-analytics":
var regex = new RegExp("FormAnalytics.aspx\?", "i");
return regex.test(topLocation);
case "playback":
var regex = new RegExp("Player.aspx\?", "i");
return regex.test(topLocation);
}
}</source>
The parameters it can be given are:
*"recording"
*"report" (all aggregated reports will return true)
*"playback" (true only in playback)
*"scroll-heatmap"
*"click-heatmap"
*"form-analytics"
So in case of a regular visitor, the function will return false for every parameter other than "recording"

This way, the [[ClickTaleExec]] command can be invoked only if it's in playback mode, and during aggregated reports, you can, for instance, choose to expand all JavaScript panels in a menu in order to better understand visitor interaction with them.<br><br><br>
This code section MUST stay outside of the tracking codes scripts and comments section (< !-- ClickTale end of Bottom part -->).
[[Category:Plugins and Integrations]]

J2EE integration module

2011-10-09T13:47:13Z

Shmuls:

{{SMB}}
==Introduction==
ClickTale is happy to announce the availability of the '''J2EE (Java Platform, Enterprise Edition)''' [[integration module]]. Based on the same architecture as [[ASP.NET integration module]] and [[PHP integration module]], the [http://en.wikipedia.org/wiki/Java_Platform,_Enterprise_Edition J2EE] module allows full integration of ClickTale with dynamic, session-based, behind-a-login and POST-processing pages.

The module is composed of a filter, a servlet and a test page and is added to the website as any other library.

==Technical notes==
If you are using struts version 2 and above, you may need to edit struts.xml and add a line to exclude our servlet from being processed by struts. See the line below:

<constant name="struts.action.excludePattern" value="/ClickTaleCache.*"/>

For older struts versions:
* Struts 1.3 - no changes to struts configuration are required.
* Customers with JDK 1.5 should use the J2EE integration module version compiled with jdk 1.4 found below – tested and works

[[Category:Plugins and Integrations]]

This [[Integration module]] is for [http://en.wikipedia.org/wiki/Java_Platform,_Enterprise_Edition J2EE] sites using dynamic content which changes for each user independently. For example, shopping carts are often such pages.
It will allow you to store the exact version that the user saw and allow our fetching bot to collect that version so it will be available to you in the playback of visitors visits and other reports.
The J2EE Integration Module adds further support to cases that were not previously covered, such as POST processing pages.

The module allows better integration of a J2EE site with ClickTale by enabling accurate caching of the HTML that is sent to the visitor in ClickTale recorded pageviews.

==Installation Guide==
<ol>
<li>Remove the existing ClickTale code and/or disable other integration methods (for example, J2EE integration code - which supports session state only).</li>
<li>Download the latest version of the ClickTale J2EE Integration module from [http://www.clicktale.com/Integration/ClickTaleJ2EEIntegrationModule_latest.zip here].</li>
<li>'''PLEASE NOTE:''' In case you need a version compiled for older JVM (1.4 and 1.5), a version compiled with jdk 1.4 is available [http://www.clicktale.com/Integration/ClickTaleJ2EEJavaPlatform1.4IntegrationModule_latest.zip here].</li>
<li>Generate the ClickTale tracking code you want to use in your pages (or locate your already generated code).</li>
<li>Decompress the 2 archive files, and copy to the site location. </li>
<li>Locate the WEB-INF/ClickTaleScripts.xml file that comes in the clicktale-sample.war file and open it in a text editor.
Paste your ClickTale Tracking Code from the previous step into the appropriate CDATA fields into the ClickTaleScripts.xml file.</li>
<li>In the bottom script before the call to ClickTale(###) function add the following line:
<source lang="javascript">
ClickTaleFetchFrom="http://%RootPath%/ClickTaleCache?h=%CacheToken%";
</source>
</li>
<li>Your xml file should now look like this (for the regular, https/SSL compliant version of the tracking code): :
<source lang="javascript">
<?xml version="1.0" encoding="utf-8" ?>

<scripts>
<script name="Top">
<![CDATA[

<script type="text/javascript">
var WRInitTime=(new Date()).getTime();
</script>

]]>
</script>
<script name="Bottom" DoNotReplaceCondition="" InsertBefore="|</body>">
<![CDATA[

<div id="ClickTaleDiv" style="display: none;"></div>
<script type='text/javascript'>
document.write(unescape("%3Cscript%20src='"+
(document.location.protocol=='https:'?
'https://clicktale.pantherssl.com/':
'http://s.clicktale.net/')+
"WRb6.js'%20type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
if(typeof ClickTale=='function')
{
var ClickTaleSSL=1;
ClickTaleFetchFrom="http://%RootPath%/ClickTaleCache?h=%CacheToken%";
ClickTale([Your ClickTale parameters]);
}
</script>

]]>
</script>
</scripts>
</source>
'''IMPORTANT NOTE! This is how the code looks like in a text editor. In a browser, "&lt;" will be converted to "<" and "&gt;" will become ">"'''</li>
<li>Locate and copy the various configuration files in the archive (WEB-INF and WEB-INF\classes) to your site. If you already using log4j or ehcache, please mind to integrate those instead of overwriting your files.</li>
<li>Locate and copy the various WEB-INF\lib files in the archive to your site.</li>
<li>Modify your WEB-INF\web.xml file to include the filter and servlet declarations as in the web.xml file that is included in the archive.</li>
<li>Copy the 'clicktale' directory to your site. This folder contains test pages that you can use to verify the correct operation of the module. You may remove the folder from production system.</li>
</ol>

Optionally: see [[Selective recordings#Selective recording via URL parameter|here]] to disable or enable yourself from being recorded. Apply this to everyone who is working with you on the site otherwise they will use recording quota, or enable this for testing to make sure all is working correctly.

===Troubleshooting===
====Enabling Logging====
After the files are copied you can navigate your browser to '''<nowiki>http://yoursite/clicktale/index.html</nowiki>''' to view some helpful information regarding the caching and other configurations. Changing info to debug in the log4j.properties file will output debug info to the console, this can be sent direct to a log file by editing the text to read:
<source lang="javascript">
log4j.rootLogger=debug, R
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d [%t] %-5p %c - %m%n
log4j.appender.R = org.apache.log4j.DailyRollingFileAppender
log4j.appender.R.File = logs/clicktale.log
log4j.appender.R.Append = true
log4j.appender.R.DatePattern = '.'yyy-MM-dd
log4j.appender.R.layout = org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern =%d [%t] %-5p %c - %m%n
</source>

Depending how the root folder is defined for your server, you might need to set the path of the log file to ../logs/clicktale.log or use another (absolute) path to enable logging correctly.

Please ensure that production servers are set back to "info" when live.

===="Invalid <url-pattern>" error message====
It is possible that you will receive this error message with older version of Java (1.4) or specific web servers (Tomcat 5.5, etc). The error will appear in the log files of your web server. Additionally, pages on the site related to the modified web.xml file will not load. To resolve the issue edit the web.xml file and modify the value of the <url-pattern> element for the ClickTale module such that it will be valid for your environment. We had good results replacing "*" with "/*"

==Configuring the caching provider==
The module caches the content of the pages so it can later provide the content to ClickTale servers for processing. This caching requires some persistent storage and so different caching providers are supported.
The default caching provider is the HashMap based, internal storage provider. You could also configure it to use a local ehcache for storage.

You can enable its provider by editing the ClickTale.properties file, commenting:
<source lang="php">#CacheProvider=com.clicktale.cache.impl.HashMapProviderImpl;</source>
and uncommenting:
<source lang="php">CacheProvider=com.clicktale.cache.impl.EhCacheProviderImpl
EhCacheName=clickTaleCache</source>

==Caching provider settings==
*DeleteAfterPull = (true / false)
**If true, the cached page is deleted after clicktale fetches it from your site
*MaxCachedPages = (integer)
**The size of the cache dir in MegaBytes. If the number of cached pages cache gets larger than that, stale caches are removed

===Use With "Expires" Header And Enable Reuse Of Cached Pages===
Some websites use "cache-control" and "expires" headers to cache pages on the client. This improves performance but may be problematic when used with our module. Pages are removed from the module's cache right after they are being accessed (for security and performance reasons). So, if a visitor browses a page more than once without refreshing the content from the server (this is usually a result of using the back button), the cache will be called several times with the same token. This will cause a cache miss for any request beyond the first one.
To overcome this problem, it is possible to use the DeleteAfterPull="false" parameter in the configuration. This will disable the removal of cached pages when the ClickTale cache is called. Cached data will be removed after MaxCachedPages="???" new pages are cached, so you might want to extend this parameter as well to allow sufficient traffic between the first pageview and the next (duplicate pageview).

==Q&A==
:'''Q: Are cached pages protected from access by third parties?'''<br>
:A: Yes, several layers of protection are in place. Only certain IPs are allowed to request the cached pages (IPs of ClickTale servers) and only processes which already have access to the page have the secret token required to request the cached content.

:'''Q: Is it possible to inject the script in other places rather than after/before body tags?'''<br>
:A: Yes. By default the top script is injected after <body> and the bottom before </body>, but this can be changed by adding a InsertAfter attribute to the script[name="Top"] element or adding a InsertBefore attribute to the script[name="Bottom"] element, both are regular expressions.

:'''Q: Some of my pages already have the ClickTale script, I do not want the script appear twice.'''<br>
:A: You should either remove the script from those pages and let the module handle the insertion or you should use DoNotReplaceCondition. See the code step 2 for an example. The default script in Step 2 is already configured to prevent double inclusion.

:'''Q: After installing the module, I tried to watch a recording but I got the following notice instead: "Request from an unauthorized IP." . What should I do?'''<br>
:A: This could be a misconfiguration, a change in our IP addresses or a hacking attempt. Please contact us so we can investigate this further.

:'''Q: I have installed the module but I don't see the tracking code in the source of the page. What is wrong?'''<br>
:A: The module will only inject the code for visitors who are classified as "to-record" (have WRUID cookie with non-zero value) or for those who are not classified (no WRUID cookie). Visitors who are classified as "not-to-record" will get no code.

:'''Q: I'm using a proxy server for my website - what steps should I take to record properly?'''<br>
:A: Move the IP restriction rule to the proxy and set the IP in ClickTale.properties (located in the WEB-INF directory) to the IP of the proxy.

:'''Q: Can I filter out specific pages from recording?'''<br>
:A: You may use the filter-mapping/url-pattern entry in the web.xml to set filters with some wildcard options.

==Using a proxy server==
If you have a proxy, whenever our servers will try to get the cache they will appear to have the address of the proxy which is not allowed by default.
To fix this, you should set the IP address of the proxy to the AllowedAddresses value in the module's ClickTale.properties file and set a rule with your proxy to allow only our servers IP range access to the cache.
Or servers' IP ranges are: 75.125.82.64/26 50.97.162.64/26 (''stands for 75.125.82.64 - 75.125.82.127 and 50.97.162.64 - 50.97.162.127'').

==Reference==
[[Integration module]] - Good read, for a general understanding of our integration modules.

[[Category:Plugins and Integrations]]

J2EE integration code

2011-10-09T13:46:39Z

Shmuls:

{{SMB}}
<center><big>'''If possible, use the [[J2EE integration module]] instead. It provides better integration with our service.<br>
The only reason to use this code is if you are unable to install a binary module on your site.'''</big></center>

__TOC__
The J2EE integration code below allows you to record dynamic pages and pages behind a login using the [[FetchFromWithCookies]] method.

Replace the bottom part of your [[tracking code]] with the one of the following to allow ClickTale to better cache the pages of your session based website:
==Standard J2EE integration code==
This code cannot record https/SSL pages.
<source lang="javascript">

<div id="ClickTaleDiv" style="display: none;"></div>
<script type="text/javascript">
if(document.location.protocol!='https:')
document.write(unescape("%3Cscript%20src='http://s.clicktale.net/WRb.js'%20type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
ClickTaleFetchFromWithCookies.setFromCookie("JSESSIONID");
// add a similar line for each additional cookie variable

ClickTaleFetchFrom = ClickTaleFetchFromWithCookies.constructFetchFromUrl();

if(typeof ClickTale=='function') ClickTale([!YOUR PARAMETERS!]);
</script>

</source>
==https compliant J2EE integration code==

This code will record https/SSL paes as well as standard pages. This functionality is not available for all plans and will not work unless supported by your current plan.

<source lang="javascript">

<div id="ClickTaleDiv" style="display: none;"></div>
<script type='text/javascript'>
document.write(unescape("%3Cscript%20src='"+
(document.location.protocol=='https:'?
'https://clicktale.pantherssl.com/':
'http://s.clicktale.net/')+
"WRb.js'%20type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
ClickTaleFetchFromWithCookies.setFromCookie("JSESSIONID");
// add a similar line for each additional cookie variable

ClickTaleFetchFrom = ClickTaleFetchFromWithCookies.constructFetchFromUrl();
var ClickTaleSSL=1;
if(typeof ClickTale=='function') ClickTale([!YOUR PARAMETERS!]);
</script>
</source>

==Adding more cookies==
'''Please note:'''
After
<source lang="javascript">
ClickTaleFetchFromWithCookies.setFromCookie("JSESSIONID");
</source>
: more lines in the form of:
<source lang="javascript">
ClickTaleFetchFromWithCookies.setFromCookie("[!COOKIENAME!]");
</source>
: may be needed, where [!COOKIENAME!] is the name of other session cookies required to properly identify your website visitors.

[[Category:Plugins and Integrations]]

HTTPS pages

2011-10-09T13:46:19Z

Shmuls:

{{SMB}}
== Who can record https pages ==
Accounts with the free plan cannot record SSL/https pages. All paid plans allow for SSL/https recording, as seen on the [http://www.clicktale.com/pricing.aspx ClickTale pricing page] under "Record HTTPS Pages". If you have a paid plan and would like to find out if you can record these pages you can do so by trying to generate a SSL/https compliant tracking code (see below). If you do not have permission you will not be able to select the appropriate radio button at the bottom of the code generation page.

'''Please note:'''<br>
If you are not subscribed to a plan which enables SSL/https recording, make sure you are using the latest code that ignores https pages.
The latest regular (non-SSL) tracking code is the one which has a line of code that begins with:
<source lang="javascript">
if(document.location.protocol!='https:')...
</source>

== Generating a SSL/https compliant tracking code ==
In the initial page during the generation of the tracking code for a new or existing project, make sure “Both HTTP and SSL/HTTPS pages” is selected at the bottom of the page.

In order to generate a new tracking code for SSL/https pages :
# Choose the project.
# Press "get tracking code".
# In "Record Secure Page" area check "Both HTTP and SSL/HTTPS pages" radio button.
# Insert the code into your https page.

'''Please note:'''
*As mentioned in the code generation page, SSL/https compliant tracking code can record both http pages and https pages.
*If you have generated your tracking code without SSL in the past and now want to generate a SSL enabled code you need to use the code generation wizard again. Changing http:// to https:// will not make your simple code become SSL enabled.
[[Category: Plugins and Integrations]]

Google Website Optimizer integration

2011-10-09T13:46:10Z

Shmuls:

{{SMB}}
'''ClickTale has two integration methods for Google Website Optimizer (GWO), please make sure you choose the correct integration method based on the type of test you are running.'''
__TOC__
==Google Website Optimizer for Split testing (A/B testing)==
Google Website Optimizer in Split test (A/B testing) mode, will redirect your entry page to a different page based on your configuration. While this is active you will not be able to play or do a report on your entry page in ClickTale.

'''With the following fix, you will be able to see the correct variation for each visitor and also aggregate each variation separately in Heatmaps or Form Analytics reports.'''
===Instructions===
If your current Google Website Optimizer code (on the "original" page) looks like this:
<source lang="javascript">
<script>
function utmx_section(){}function utmx(){}
(function(){var k='XXXXXXXXXX',d=document,l=d.location,c=d.cookie;function f(n){
if(c){var i=c.indexOf(n+'=');if(i>-1){var j=c.indexOf(';',i);return c.substring(i+n.
length+1,j<0?c.length:j)}}}var x=f('__utmx'),xx=f('__utmxx'),h=l.hash;
d.write('<sc'+'ript src="'+
'http'+(l.protocol=='https:'?'s://ssl':'://www')+'.google-analytics.com'
+'/siteopt.js?v=1&utmxkey='+k+'&utmx='+(x?x:'')+'&utmxx='+(xx?xx:'')+'&utmxtime='
+new Date().valueOf()+(h?'&utmxhash='+escape(h.substr(1)):'')+
'" type="text/javascript" charset="utf-8"></sc'+'ript>')})();
</script><script>utmx("url",'A/B');</script>
</source>
Change it to
<source lang="javascript">
<script>
var CTIsPlayback=true;
try
{
if(!parent || !parent.WebPlayer) // if there is no WebPlayer or if the above frame is not accessible
throw false;
} catch(e) { CTIsPlayback=false; }
</script>
<script>
function utmx_section(){}function utmx(){}
if(!CTIsPlayback)
{
(function(){var k='XXXXXXXXXX',d=document,l=d.location,c=d.cookie;function f(n){
if(c){var i=c.indexOf(n+'=');if(i>-1){var j=c.indexOf(';',i);return c.substring(i+n.
length+1,j<0?c.length:j)}}}var x=f('__utmx'),xx=f('__utmxx'),h=l.hash;
d.write('<sc'+'ript src="'+
'http'+(l.protocol=='https:'?'s://ssl':'://www')+'.google-analytics.com'
+'/siteopt.js?v=1&utmxkey='+k+'&utmx='+(x?x:'')+'&utmxx='+(xx?xx:'')+'&utmxtime='
+new Date().valueOf()+(h?'&utmxhash='+escape(h.substr(1)):'')+
'" type="text/javascript" charset="utf-8"></sc'+'ript>')})();
}
</script>
<script>
if(!CTIsPlayback)
utmx("url",'A/B');
</script>
</source>
'''Note: The ID in the code varies per test and needs to be changed to the ID you have been provided by from Google Website Optimizer.'''<br>
This will run Google Website Optimizer A/B testing in any normal use of the page and not run it when doing ClickTale playback.
==Google Website Optimizer for Multivariate testing==
When using GWO Multivariate testing and ClickTale without correct code customization, the playback of the recorded pages and aggregation reports will not be accurate and will probably not display the combination that the user saw.

'''With the following integration, you will be able to see the correct variation for each visitor and also aggregate each variation separately in Heatmaps or Form Analytics reports.'''
===Introduction===
Let's assume we are integrating with a page that has 3 sections and 2 variations for each section.
====Finding your GWO experiment ID====
The experiment ID is the alphanumeric string immediately following experiment=. For example, in the URL:

'''<nowiki>https://www.google.com/analytics/siteopt/mv_prepare_install?experiment=AgAAAIuElaplZk1wAusMbP0ZUYo&account=00000001</nowiki>'''<br>the experiment ID is AgAAAIuElaplZk1wAusMbP0ZUYo.
====Accessing specific combinations by using special URL params====
To view a specific combination you can append the following string to your test URL:
#utmxid='''Experiment_ID''';utmxpreview='''Combination_number'''

'''Combination_number''' should look similar to this in our case: 1-0-1 (2nd variation in first section, 1st variation in second section and 2nd variation in third section)

''For more information please see http://www.google.com/support/websiteoptimizer/bin/answer.py?hl=en&answer=63841''
===Adding customized code to you page===
This is done to save the combination that the user sees on the page to be used later for playback.

There are two different scripts depending on whether you have one multivariate test running on your site, or multiple tests running simultaneously.
====With one multivariate test on your site====
'''Note: This script can be part of the bottom script that is injected to the page in case you are using a ClickTale integration module.'''

Add this JS code right after the ClickTale bottom part script: (replace the '''Experiment_ID''' with your experiment ID)
<source lang="javascript">

<script type="text/javascript">
if (typeof ClickTaleField == 'function' && utmx("combination_string")) {
ClickTaleField('CT.InitialLocationParams', "#utmxid=Experiment_ID;utmxpreview=" + utmx("combination_string"));
ClickTaleTag('GWO: ' + utmx("combination_string"));
}
</script>

</source>
'''Note: It’s best to keep the experiment ID in a config file along with the unique identifier for the experiment that you can see in the control script (....var k=<nowiki>'</nowiki>'''2376510756'''<nowiki>'</nowiki>,d=....). This way you will not need to copy paste it from page to page and so it will be convenient to use the same code for more than one multivariate experiment running at the same time on different pages.'''
====With multiple multivariate tests on your site====
'''If you have more than one multivariate test on your site and you are using ClickTale integration module or if you don’t want to change the tracking code each time you create another test please use the method explained below:'''

'''By using the code below you can define all the experiment IDs for all the MVT testing in your site. You will not need to change the code on the page if this is populated for example from your config file.'''

Add this JS code at the top part of the page (best place is to put it next to the ClickTale top script):

<source lang="javascript">

<script type="text/javascript">
var Id2ExperimentId={'k1':'ExperimentID1','k2':'ExperimentID2'};
</script>

</source>
Add this JS code right after the ClickTale bottom part script:

'''Note: This script can be part of the bottom script that is injected to the page in case you are using integration module.'''
<source lang="javascript">

<script type="text/javascript">
var detectk = "";
try {
for (var i=0; i<document.getElementsByTagName("script").length; i++) {
var scr = document.getElementsByTagName("script")[i];
var content = scr.innerHTML;
if (content.indexOf("k='") > -1) {
var match = /$function\(${var k='(\d+)',d=document,l=d\.location,c=d\.cookie;/.exec(content);
if(match && match.length >= 2) {
detectk = match[1];
}
}
}
}
catch (e) { detectk = ""; }
if (detectk != "") {
if (typeof ClickTaleField == 'function' && utmx("combination_string")) {
ClickTaleField('CT.InitialLocationParams', "#utmxid=" + Id2ExperimentId[detectk] + ";utmxpreview="+utmx("combination_string"));
ClickTaleTag('GWO: ' + utmx("combination_string"));
}
}</script>

</source>
[[Category:Plugins and Integrations]]

Google SEO integration

2011-10-09T13:46:02Z

Shmuls:

{{SMB}}
Ever wonder which words lead visitors to your site? Using this method you can find out how many pageviews you got for each keyword, as well as how the visitors searching for those keywords behaved:
==Instructions==
Place the following code on your website, instead of the bottom part of your [[tracking code]]:
<source lang="javascript">
<div id="ClickTaleDiv" style="display: none;"></div>
<script type="text/javascript">
function queryString(parameter, encoded) {
var loc_search = location.search.substring(1, location.search.length);
loc_search = loc_search.replace(/\+/g, ' ');
var param_value = false;
var params = loc_search.split("&");
if(!encoded) {
parameter = encodeURIComponent(parameter);
}
for (i=0; i<params.length;i++) {
param_name = params[i].substring(0,params[i].indexOf('='));
if (param_name == parameter) {
param_value = params[i].substring(params[i].indexOf('=')+1)
}
}
if (param_value) {
return param_value;
}
else {
return false; // case parameter wasn't found
}
}
</script>
<script src="http://s.clicktale.net/WRb.js" type="text/javascript"></script>
<script type="text/javascript">
if (document.referrer. match(“www.google.com”) != null) {
var search_string = queryString("q");
var search_words = search_string.split("+");
for (i=0; i< search_words.length;i++) {
ClickTaleTag("googlesearch:"+search_words[i]); }
}
if(typeof ClickTale=='function') ClickTale([!YOUR PROJECT ID!],recordingratio,[!PARTITION!]);
</script>
</source>
This tags the pageviews with a tag entitled “googlesearch:”+the term that was searched.
#Use the [[Search]] page [[Events]] filter to see which search words got the highest popularity rating (=pageviews). Select the Events with the search terms if you want to view the behavior of visitors who used these terms to reach your site.
[[Category:Plugins and Integrations]]

Google Maps integration

2011-10-09T13:45:54Z

Shmuls:

{{SMB}}
If you are using Google Maps on your website you might receive the following message when loading movies or reports for your site:
"The Google Maps API key used on this website was registered for a different website." This is due to ClickTale caching your pages from your domain and then showing them from our own domain(cross-domain), the API security prevents the key being used in an unassigned domain. The solution is to disable activating Google Maps while your site pages are shown and analysed in your ClickTale Account whilst leaving the functionality on the site unchanged.
==Instructions==
Open the page where your Google Maps code is located. Find a line that says:
<source lang="javascript">
if (GBrowserIsCompatible())</source>
and change it to:
<source lang="javascript">function CTIsPlayback() {
try { return parent && parent.WebPlayer; }
catch(e) { return false; }
}
if (GBrowserIsCompatible() && !CTIsPlayback() )</source>
If Google Maps initialization happens after the ClickTale [[tracking code]] has been loaded you can also implement the change as:
<source lang="javascript">
if (GBrowserIsCompatible() && !(typeof ClickTaleIsPlayback=="function" && ClickTaleIsPlayback() ) )</source>
Publish the modified file online. The change will not affect any existing recordings.
==Alternative solution==
In certain rare cases the above code may not work. If so, just use the [[ClickTaleExcludeBlock]] to ignore the Google Maps code by wrapping the script tag:
<source lang="html4strict"><script type="text/javascript" src="http://maps.google.com/maps?file=api... ></script></source>
like so:
<source lang="html4strict">
<script type="text/javascript" src="http://maps.google.com/maps?file=api... ></script>
</source>
[[Category:Plugins and Integrations]]

Google AdWords integration

2011-10-09T13:44:31Z

Shmuls:

{{SMB}}
This method allows you to use your recording quota to record only visitors who have arrived via a Google AdWords campaign:
#Make sure the URL which these visitors arrive at has an extra identifying parameter, such as ref=adwords
#Place the following code on your website, instead of the bottom part of your [[tracking code]]:
<source lang="javascript">
<div id="ClickTaleDiv" style="display: none;"></div>
<script src="http://s.clicktale.net/WRb.js" type="text/javascript"></script>
<script type="text/javascript">
var recordingratio = 0;
if (/[\/?&]ref=[^&]*adwords($|&|#)/i.test(window.location.href) || ClickTaleGetUID()!=null) {
recordingratio = 1;
}
if(typeof ClickTale=='function') ClickTale([!YOUR PROJECT ID!],recordingratio,[!PARTITION!]);
</script>
</source>

[[Category:Plugins and Integrations]]

Template:SMB

2011-10-09T13:09:09Z

Shmuls:

Google AdSense integration

2011-10-09T13:02:54Z

Shmuls:

{{SMB}}
When using [[ClickTaleUploadPage]] API method and AdSense, your ad blocks will be shown twice during playback. This is because in "client-capture" mode, the ads are rendered twice, once during recording and once during playback.

To correct this you can add some code to your pages that will remove the second instance of the ad.
==Instructions==
<ol>
<li>Create a js file (i.e. clicktale-adsense.js) and include the following code in it
<source lang="javascript">function ClickTaleRemoveAdsenseFrame()
{
if (typeof ClickTaleIsPlayback != 'function' || ClickTaleIsPlayback() )
{
var c=document.getElementsByName('google_ads_frame');
if(c.length)
{
var e=c.item(c.length-1);
e.parentNode.removeChild(e);
}
}
}</source>
</li>
<li>Include this js file by adding the following line in every html page where you have adsense ads
<source lang="html4strict"><script type="text/javascript" src="clicktale-adsense.js"></script></source>
</li>
<li>After each block of adsense add the following code
<source lang="html4strict"><script type="text/javascript">ClickTaleRemoveAdsenseFrame();</script></source>
</li></ol>
'''Note: a block of adsense ends with a'''
<source lang="html4strict"><script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"></script></source>
'''Advanced note: if you only have one block of adsense, you can execute the body of the function inline right after the ad block and not use an additional file.'''

:'''Q: Why do my Google AdSense Frames say "ClickTale Adsense Frame" on the heat maps?'''
:A: This means we replace your Google AdSense banner with this frame at the time of playback so that it doesn't count as wasted impressions in your AdSense program.

[[Category:Plugins_and_Integrations]]

Flash integration

2011-10-09T13:02:07Z

Shmuls:

{{SMB}}
ClickTale is able to record mouse moves and clicks over flash elements, as well as create heatmaps of pages containing flash. We do not at the moment support dynamic Flash elements in visitor playback sessions, or completely Flash based sites, due to the various ways that different browsers handle Flash requests.<br>

==Using ClickTale over Flash==
To configure ClickTale to see mouse movements and clicks over Flash elements while watching visitor recordings, specify a "wmode" parameter for your flash.

To specify a "wmode" add:
<source lang="html4strict"><param name="wmode" value="opaque"></source>
or:
<source lang="html4strict"><param name="wmode" value="transparent"></source>
to your Flashs object's parameter list.<br>
See [http://kb.adobe.com/selfservice/viewContent.do?externalId=tn_15523&sliceId=2 this Adobe KnowledgeBase item] for more information.

If using Internet Explorer to playback the movies, set Playback Scale to 100%, otherwise your Flash might not be shown.

You will not be able to see the Flash element change in sync with the actions that the visitor performed, nor see Link Analytics report metrics on Flash elements out of the box. One solution is to use tagging to monitor actions that happen in Flash. To do so implement calls from Flash to the [[ClickTaleTag]] function.
[[Category:Plugins and Integrations]]

Drupal integration

2011-10-09T10:43:48Z

Shmuls:

{{SMB}}
There are three methods for recording visitors pages built on the open source Drupal CMS platform.
__TOC__
==Using the standard ClickTale tracking code==
If you wish to use the standard tracking code, you can put it in the template or in a general block at the bottom of the page.
==Using the PHP integration module==
If you wish to record pages which require visitors to be logged in to view, or pages which have dynamic, user-specific content, or POST pages which have content unavailable via GET, we recommend you incorporate the [[PHP integration module]].<br/> '''Please note:''' when installing the module, make sure you place the PHP code lines (from step 7 in the installation guide) in your index.php file and not in your .tpl files.
==Using the Drupal Integration (Legacy)==
<br/>
'''This solution is a legacy solution and we strongly recommend using the [[PHP integration module]] instead.'''
<br/>
<br/>
<br/>
''This module was created by Nick Vandervreken, a programmer for the Belgian Drupal bureau [http://www.coworks.net/ Coworks].''
<br/>
'' For more information, please see the [http://drupal.org/node/792306 module documentation]''
<br/>
<br/>
'''Please note! To successfully use this module you might need to upgrade the PHP integration module files that come with the Drupal module with those of the latest PHP IM version. You can download the latest PHP IM files from [http://www.clicktale.com/integration/ClickTalePHPIntegrationModule_latest.zip here].'''
===Requirements===
*Drupal 6.x
*PHP Integration module (version 0.9 is included but needs to be updated)
*The ClickTale Drupal integration module (can be downloaded at http://drupal.org/files/issues/clicktale-1.01.zip)

===Installation===
The ClickTale module offers support for the ClickTale tracking engine (www.clicktale.net).
It allows the user to create different configurations and blacklist/whitelist pages,
ip-addresses and ranges.
Pages and IP-ranges can be specified using a regex to allow the user
to match a range of IP addresses or pages with the same parent with one rule.

The ClickTale module requires the PHP Integration Module to be installed inside the clicktale
directory and a valid ClickTale account. Free ClickTale accounts can be used for testing purposes
but have limitations.

When enabled, the module adds several pages to the administration menu. These are
grouped under '''/admin/settings/clicktale'''.

The module will look for the PHP Integration Module in '''/sites/all/libraries''', and will place
a "clicktale" directory in the files directory. The Cache files created by the PHP Integration
Module will be placed in this directory and will be automatically deleted after pull.
In case of multisites the PHP Integration module can be placed in '''/sites/all/libraries''' OR
in your subsite libary folder at '''/sites/%subsite%/libraries'''. The Cache and Logs will be placed
in '''/sites/%subsite%/files/clicktale'''.

Problems have been reported with PHP Integrations versions higher than 0.9.
If the Cache-folder remains empty while the ClickTale module is running you might be running
a version of PHP Integrations higher than 0.9.
A compressed version of the PHP Integrations module might be included in this package.
===Where to get the ClickTale ID and project number?===
The ClickTale ID and project number are given with your ClickTale code.<br>
If your code should be for example "ClickTale(1874, 1, 'www03');", your ClickTale ID would be "1874" and project number 'www03'. The '1' stands for a '100%' of visitors to be tracked.
===I can't see any hits on my ClickTale account.===
PHP Integrations module caches the pages in a Cache folder, this should be created in your Drupal file directory. If it's not, please check your status screen or recent logs to look for a reason. If the Cache folder is empty, it is possible that you are using a version of PHP Integration Module higher than 0.9. If there are files inside the Cache folder they will be pulled by ClickTale servers and everything should work fine. This can take a while though.
===What is the use of the PHP Integration module?===
The PHP Integration module caches the page output and stores it on the harddisk in Cache files. These files are then pulled by the ClickTale servers so the pageviews will be visible in ClickTale. Without the PHP Integration module every page you check Heatmaps or Clickmaps for would look like the version of the page at that specific time, which means specific user content or content related to the users status would not be visible. With PHP Integrations you see the content as it was shown to the user.
===How do the configurations work?===
The ClickTale module has the ability to work with different configuration settings. Each configuration has its own set of rules to decide wether to count a pageview or not.

To configure a configuration set, navigate to /admin/settings/clicktale/configurations, check the configuration you want to edit and click 'Configure'.

It is possible to only track a number of user roles. If a user role is not checked, ClickTale will NOT count hits from any user in that role.

The filters for pages and IP addresses have a blacklist/whitelist mode and support simple RegEx codes.

*Count all pages except administration pages
:Page mode: blacklist
:admin/*

*Only count hits from non-logged in users and in /page/to/discard and its subpages
:Page mode: whitelist
:page/to/discard*
:Only tick off 'anonymous user'

*Count all hits except those from a local network
:IP mode: blacklist
:192.168.*.*

*Count all hits except those from certain IP addresses on the local network
:IP mode: blacklist
:192.168.0.(100|101|105)
===How can I see if ClickTale is counting?===
By enabling the processing log you can check wether or not the ClickTale module is counting the pageviews.
This log will also show you if one of the rules you set up in the configuration matched the current pageview.
Use this to set up the configuration, but do not leave it on afterwards!

If ClickTale is counting in the processing log but the hits are not showing up in the ClickTale website,
the problem will most likely be either the file permissions or account settings.

To check if the file permissions are OK, check the Cache directory to see if cache files are being rendered.
You'll find this directory in /sites/default/files/clicktale/Cache or /sites/%subsite%/files/clicktale/Cache.

If cache files are generated but the hits are not showing up in your ClickTale account, the problem most likely lies with your account settings. Check wether the ClickTale ID is correct, your ClickTale ratio is 1 and your
ClickTale project number is the one specified for that account.

==TroubleShooting==
===CSS not showing in recordings===
Websites built in Drupal, often have their CSS files cached with varying alphanumeric strings as file names, causing the old links with these tokens to be broken.
The simplest way to solve this issue in future recordings is to save versions of the any style sheets you use in fixed URLs (separate from the Drupal cache), then reference these URLs in playback instead of the CSS path visitors see (which is subject to change), using the [[ClickTaleExcludeBlock]] method (blocking the current CSS link from being recorded, and using the alternate content option in order to reference the fixed path).

[[Category:Plugins and Integrations]]

ColdFusion integration code

2011-10-09T10:43:26Z

Shmuls:

{{SMB}}
The ColdFusion integration code allows you to record dynamic pages and pages behind a login using the [[FetchFromWithCookies]] method.

This code will enable to get the data stored in session cookies, which helps identify your visitors (and changes the content of parts of your site accordingly). Instead of the bottom part of the [[tracking code]], please place the following code:
<source lang="html4strict">

<div id="ClickTaleDiv" style="display: none;"></div>
<script type="text/javascript">
if(document.location.protocol!='https:')
document.write(unescape("%3Cscript%20src='http://s.clicktale.net/WRb.js'%20type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
ClickTaleFetchFromWithCookies.setFromCookie("CFID");
ClickTaleFetchFromWithCookies.setFromCookie("CFTOKEN");
// add similar line for each additional cookie variable

ClickTaleFetchFrom = ClickTaleFetchFromWithCookies.constructFetchFromUrl();

if(typeof ClickTale=='function') ClickTale([!YOUR PARAMETERS!]);
</script>
</source>

'''Please note:'''
*This code is not https/SSL compliant. To enable the recording of https pages (available to premium subscribers) you need to generate an https/SSL tracking code for your project and augment that code's bottom part similarly to the code appearing here.
*After
<source lang="javascript">ClickTaleFetchFromWithCookies.setFromCookie("CFTOKEN");</source>
:more lines in the form of:
<source lang="javascript">ClickTaleFetchFromWithCookies.setFromCookie("[!COOKIENAME!]");</source>
:are probably needed, where [!COOKIENAME!] is the name of other session cookies required to properly identify your website visitors.
[[Category:Plugins and Integrations]]

ClickTaleFetchFromWithCookies

2011-10-09T10:43:06Z

Shmuls:

{{SMB}}
__TOC__
ClickTaleFetchFromWithCookies is an extension to the regular ClickTale tracking code that allows correct caching of pages that depend on cookie values. The cookies could contain session identifiers (session cookies) or simple values. The values collected during recording time will be passed to your server during the caching (AKA fetching) stage. Your server would then recognize a visitor's session on your website and render the page content accordingly (e.g. display a shopping cart's contents). This script is used in several integrations, including those for [[Classic_ASP|Classic ASP]] and [[JSP]].

<u>'''If you are hosting an older version of the recorder file (before WRc3.js) and for some reason unable to update it please use [[Old FetchFromWithCookies]].'''</u>

==Using ClickTaleFetchFromWithCookies==
<ol><li>
For each cookie you would like to simulate, add the following line:
<source lang="html4strict">
ClickTaleFetchFromWithCookies.setFromCookie("[!COOKIENAME!]");
</source>
Where [!COOKIENAME!] is replaced with the name of the cookie.<br/>
'''Please note:''' The parameter setFromCookie can be either a String or a RegExp (Regular Expression), in order to accommodate cookies with a varying name. For example:
<source lang="html4strict">
ClickTaleFetchFromWithCookies.setFromCookie(/^ASPSESSIONID.*/);
</source>
Can be used for recording cookies which are named "ASPSESSIONID" + an alphanumeric code, unique for each visitor.
</li>
<li>
Finally, after the last cookie name (and before the line that starts with "if(typeof ClickTale=='function')"), add the code line:
<source lang="html4strict">
ClickTaleFetchFrom = ClickTaleFetchFromWithCookies.constructFetchFromUrl();
</source>
</li>
</ol>
See here for [[Code_Examples]]

==Specifying a URL==
Much like the [[ClickTaleFetchFrom]] variable, the ClickTaleFetchFromWithCookies also enables you to define where to fetch the page html from (a different source than the page the code is located on). This is done by entering the URL as a parameter in the constructFetchFromUrl function:
<source lang="html4strict">
ClickTaleFetchFrom = ClickTaleFetchFromWithCookies.constructFetchFromUrl([URL FOR HTML SOURCE]);
</source>
This can come in handy for instance when employing the ClickTaleFetchFrom solution for POST pages (noted [[POST_pages#Possible_solutions|here]]).

==Using in conjunction with an integration module==
Since integration modules have an xml file which is used as a centralized source for the tracking code, the ClickTaleFetchFromWithCookies should be implemented there. The addition of ClickTaleFetchFromWithCookies is done similarly to the way it's added to regular tracking code, with one exception. Since the code in the xml already includes a ClickTaleFetchFrom line, the URL in it should be used in the constructFetchFromUrl command instead. For example, The code in the ClickTaleScripts.xml file for the [[ASP.NET]] integration module contains the line:
<source lang="javascript">
ClickTaleFetchFrom="http://%RootPath%/ClickTaleCache.ashx?t=%CacheToken%";
</source>
When adding the ClickTaleFetchFromWithCookies code the list of cookies added using setFromCookie is placed normally, while the ClickTaleFetchFrom line is changed to:
<source lang="javascript">
ClickTaleFetchFrom=ClickTaleFetchFromWithCookies.constructFetchFromUrl("http://%RootPath%/ClickTaleCache.ashx?t=%CacheToken%");
</source>

Classic ASP integration code

2011-10-09T10:42:44Z

Shmuls:

{{SMB}}
The Classic ASP integration code allows you to record dynamic pages and pages behind a login using the [[FetchFromWithCookies]] method.

===Integration with third-party applications===
Please use the [[Volusion integration]] method if you are using Volusion on your website.

==Classic ASP integration code==
Replace the bottom part of your [[tracking code]] with the one of the following to allow ClickTale to better cache the pages of your session based website:

===Standard Classic ASP code===

This code cannot record https/SSL pages.

<source lang="javascript">

<div id="ClickTaleDiv" style="display: none;"></div>
<script type="text/javascript">
if(document.location.protocol!='https:')
document.write(unescape("%3Cscript%20src='http://s.clicktale.net/WRb.js'%20type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
ClickTaleFetchFromWithCookies.setFromCookie(/^ASPSESSIONID.*/);
// add a similar line for each additional cookie variable

ClickTaleFetchFrom = ClickTaleFetchFromWithCookies.constructFetchFromUrl();

if(typeof ClickTale=='function') ClickTale([!YOUR PARAMETERS!]);
</script>
</source>

===https compliant Classic ASP code===

This code will record https/SSL pages as well as standard pages. This functionality is not available for all plans and will not work unless supported by your current plan.

<source lang="javascript">

<div id="ClickTaleDiv" style="display: none;"></div>
<script type='text/javascript'>
document.write(unescape("%3Cscript%20src='"+
(document.location.protocol=='https:'?
'https://clicktale.pantherssl.com/':
'http://s.clicktale.net/')+
"WRb.js'%20type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
ClickTaleFetchFromWithCookies.setFromCookie(/^ASPSESSIONID.*/);
// add a similar line for each additional cookie variable

ClickTaleFetchFrom = ClickTaleFetchFromWithCookies.constructFetchFromUrl();
var ClickTaleSSL=1;
if(typeof ClickTale=='function') ClickTale([!YOUR PARAMETERS!]);
</script>
</source>

===Adding more cookies===
'''Please note:'''
After
<source lang="javascript">
ClickTaleFetchFromWithCookies.setFromCookie(/^ASPSESSIONID.*/);
</source>
: more lines in the form of:
<source lang="javascript">
ClickTaleFetchFromWithCookies.setFromCookie("[!COOKIENAME!]");
</source>
: may be needed, where [!COOKIENAME!] is the name of other session cookies required to properly identify your website visitors.

[[Category:Plugins and Integrations]]

Blogger integration

2011-10-09T10:42:32Z

Shmuls:

{{SMB}}
Integrating ClickTale into your Blogger blog couldn't be easier.
==Automatic integration==
#Once you have generated your [[tracking code]] for your account, click on the Blogger widget you will see in the right hand panel of the code creation page.
==Manual integration==
#Login to your Blogger account and choose a blog from the list of your blogs.
#Click the "Layout" tab, then the "edit HTML" menu item. (If you are using a older version of Blogger and don't see this tab click the "Template" tab instead.)
#Locate the <body> tag and paste the two parts of the [[tracking code]] generated by ClickTale right after it.
That's it!
[[Category:Plugins and Integrations]]

BigCommerce integration

2011-10-09T10:42:19Z

Shmuls:

{{SMB}}
Websites which use the shopping cart software BigCommerce can integrate ClickTale by following these steps:

#Sign into your BigCommerce account and click on "Settings"
#In the list that opens, choose "Affiliate Settings"
#Add the Bottom Part of your ClickTale tracking code (using [[ClickTaleFetchFromWithCookies]] - see example below) to the "Conversion Tracking Code" box and click "Save"

===Sample code:===
'''Please Note:'''
* The code below is an HTTPS compliant code (only available for paid plans, Free accounts must edit the code).
* You will not be able to include the Top Part of the tracking code. The Top Part is not necessary for recording as it's merely a time stamp(with the exception of the PHP Integration Module).
* You may need to change the cookies below for your specific site. See the [[ClickTaleFetchFromWithCookies]] page for more details.

<source lang="javascript">
<div id="ClickTaleDiv" style="display: none;"></div>
<script type='text/javascript'>
document.write(unescape("%3Cscript%20src='"+
(document.location.protocol=='https:'?
'https://clicktale.pantherssl.com/':
'http://s.clicktale.net/')+
"WRb.js'%20type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
ClickTaleFetchFromWithCookies.setFromCookie("STORE_VISITOR");
ClickTaleFetchFromWithCookies.setFromCookie("STORESUITE_CP_TOKEN");
ClickTaleFetchFromWithCookies.setFromCookie("SHOP_SESSION_TOKEN");
ClickTaleFetchFromWithCookies.setFromCookie("SHOP_ORDER_TOKEN");
ClickTaleFetchFromWithCookies.setFromCookie("RememberToken");
ClickTaleFetchFrom = ClickTaleFetchFromWithCookies.constructFetchFromUrl();

var ClickTaleSSL=1;
if(typeof ClickTale=='function') ClickTale(your project details);
</script>

</source>
[[Category:Plugins_and_Integrations]]

Apache integration

2011-10-09T10:42:06Z

Shmuls:

{{SMB}}
The following code is only necessary if our bots are unable to capture pages.
==Instructions==
The principle is very simple. You just need to add ClickTale IP address range to the allow list in the .htaccess file which restricts the access.
Add a directive (a line of text) with the following content
<pre>
Allow from 75.125.82.64/26
Allow from 50.97.162.64/26
</pre>
As a result, your .htaccess file might look similar to this:
<pre>AuthType Basic
Order allow,deny
Satisfy any
Allow from 75.125.82.64/26
Allow from 50.97.162.64/26
</pre>
This should enable our servers located at 75.125.82.64/26 and 50.97.162.64/26 to access your restricted directories.

'''Note: your site might be using .htaccess files without you being necessarily aware of it. There are several authorization packages built on top of .htaccess infrastructure that you might be using.'''

[[Category:Plugins_and_Integrations]]

ASP.NET integration module

2011-10-09T10:41:28Z

Shmuls:

{{SMB}}
ClickTale users can download and begin using this [[Integration module]] on [http://en.wikipedia.org/wiki/ASP.NET ASP.NET] 1.1 - 4.0 websites and applications to simplify ClickTale procedures. The integration module allows for the automatic injection of ClickTale Script on to all outgoing pages and the automatic caching of page content. You'll be able to use ClickTale for recording pages that were previously problematic, including password protected pages, pages that depend on session objects, pages with random elements and POST processing pages. Its features include:
*Automatic injection of ClickTale script to all outgoing pages.
*Automatic caching of page content.
The benefits of using this module are:
*Having a single location for your ClickTale script makes it easier for you to take advantage of the benefits that ClickTale provides.
*ClickTale will be able to record all sorts of problematic pages such as: password protected pages, pages that depend on session objects, pages with random elements and POST processing pages.
With this release we are targeting web developers and development departments of online companies. Use of this module requires some technical knowledge.
This module isn't appropriate to you if you have a [[PHP integration module|PHP]] or a [[Classic ASP integration code|classic ASP site]] or if you would like to inject the script into static HTML files.
==Installation Guide==
ClickTale ASP.NET Integration Module v1.6<br>
The module should work on .NET 1.1 - 4.0 sites.

<u>'''If you are unable to install a binary module on your site, use the [[ASP.NET integration code]] instead.'''</u>

===Step 1 - Getting the archive===
Download and unzip the module [http://www.clicktale.com/Integration/ClickTaleASPNETIntegrationModule_latest.zip here].<br>
Create a "bin" folder if not already present in your website and put ClickTaleIntegrationModule.dll inside of it. A .NET 1.1 version of the module can be found in the FX1_1 directory.
===Step 2 - Preparing the tracking code for injection===
2.1 Remove the existing ClickTale code and/or disable other integration methods<br/>
2.2 Locate the ClickTaleScripts.xml file that comes in the ZIP file and open it in a text editor. Paste your ClickTale scripts (which were generated for you by the tracking code generator) into the appropriate CDATA fields in the XML file. <br/>
2.3 In the bottom script before the call to ClickTale(###) function add the following line:
<source lang="javascript">
ClickTaleFetchFrom="http://%RootPath%/ClickTaleCache.ashx?t=%CacheToken%";</source>

'''Please note: you do not need to change "%RootPath%/" to a specific Path. It will be replaced automatically during the rendering process, with a value dependent on the page being recorded.'''<br>
<br>
2.4 Check your ClickTaleScripts.xml file - it should now look like this (for the regular, http only, version of the tracking code):
<source lang="javascript">
<?xml version="1.0" encoding="utf-8" ?>

<scripts>
<script name="Top" DoNotReplaceCondition = "()">
<![CDATA[<script type="text/javascript">
var WRInitTime=(new Date()).getTime();
</script>]]>
</script>
<script name="Bottom" DoNotReplaceCondition = "()">
<![CDATA[
<div id="ClickTale" style="display: none;"></div>
<script type="text/javascript">
if(document.location.protocol!='https:')
document.write(unescape("%3Cscript src='http://s.clicktale.net/WRb6.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
ClickTaleFetchFrom="http://%RootPath%/ClickTaleCache.ashx?t=%CacheToken%";
if(typeof ClickTale=='function') ClickTale([!Your Parameters!]);
</script>
]]>
</script>
</scripts>
</source>
Save ClickTaleScripts.xml in the root of your web site. You may put it in another place, but then you will have to modify the path of the ScriptsFile parameter on the web.config file.<br>
'''IMPORTANT NOTE! This code sample relates to http tracking code only! For tracking code which can record both http and https pages you should first make sure your plan offers the ability to record https pages (check if the option is available in the tracking code generation page), then generate SSL/https compliant code and use it in step 2 instead , see below for an example of how the ClickTaleScripts.xml file would look like for the SSL/https compliant code.'''

<source lang="javascript">
<?xml version="1.0" encoding="utf-8" ?>

<scripts>
<script name="Top" DoNotReplaceCondition = "()">
<![CDATA[<script type="text/javascript">
var WRInitTime=(new Date()).getTime();
</script>]]>
</script>
<script name="Bottom" DoNotReplaceCondition = "()">
<![CDATA[
<div id="ClickTaleDiv" style="display: none;"></div>
<script type='text/javascript'>
document.write(unescape("%3Cscript%20src='"+
(document.location.protocol=='https:'?
'https://clicktale.pantherssl.com/':
'http://s.clicktale.net/')+
"WRb6.js'%20type='text/javascript'%3E%3C/script%3E"));
</script>
<script type='text/javascript'>
ClickTaleFetchFrom="http://%RootPath%/ClickTaleCache.ashx?t=%CacheToken%";
var ClickTaleSSL=1;
if(typeof ClickTale=='function') ClickTale([!YOUR PARAMETERS!]);
</script>
]]>
</script>
</scripts>
</source>

===Step 3 - Configuring the module===
Open your website's "web.config" file. Copy the following code right after the <configuration> tag.<br>
Notice that the ClickTale script will be added to all pages that are being served by this specific config file unless a "do not insert" condition is met. See the Q&A section if you need to exclude certain .aspx files from processing.
<source lang="xml">
<configSections>
<section name="ClickTale.IntegrationModuleSettings" type="System.Configuration.SingleTagSectionHandler"/>
</configSections>
<ClickTale.IntegrationModuleSettings
ScriptsFile="~\ClickTaleScripts.xml"
DoNotProcessCookieName="WRUID"
DoNotProcessCookieValue ="0"
MaxCachedPages="100"
AllowedAddresses ="75.125.82.64/26 50.97.162.64/26"/> 
</source>
The MaxCachedPages parameter depends on your server hardware capabilities and the amount of maximal memory you want to allocate for caching. Change it according to your needs. Considering that an average page size of about 40KB, 100 cached pages can mean 4Mb of your servers' memory.
===Step 4 - Enabling the module===
Look for <system.web> element in the config file and insert the following code between the tags:
<source lang="xml">
<httpModules>
<add name="ClickTaleIntegrationModule" type="ClickTale.IntegrationModule.ClickTaleIntegrationModule, ClickTaleIntegrationModule" />
</httpModules>
</source>
Note: if you already have a <nowiki><httpModules></nowiki> section then just copy&paste the <nowiki><add ...></nowiki> tag into it.<br>
This activates the module. If you ever want to disable to module it is enough to comment out this section.
'''Please Note:''' If you already have tracking code which you entered manually in your pages, you should remove it as it inhibits the module from injecting the tracking code found within the xml file on these pages.

===Step 5 - Testing===
For optimization purposes, the module will only inject the code for visitors who are classified as "to-record" (have WRUID cookie with non-zero value) or for those who are not classified (no WRUID cookie). Visitors who are classified as "not-to-record" will get no tracking code added to their HTML. As a result you might not see the tracking code in the source of the page. This doesn't mean that the module doesn't work. Your classification depends on your ClickTale recording ratio and luck.<br>
You can use a cookie editor to set the WRUID cookie to some value such as "1".<br>
Alternatively, you can clear cookies, then force yourself to be recorded by following the instructions [[Selective recordings#Selective recording via URL parameter|here]] note: the advanced selective recording script can be used in the ClickTaleScripts.xml to conditionally record visitors.
Once you are classified as "to-record" you should see the tracking code in the source code of each page on your site and recording should take place. If you still don't see the code, please proceed to the next section.

==Troubleshooting and debugging==
The module has several debugging facilities. There is a debug page, a log and some configuration flags that control debug levels.<br>
The relevant configuration parameters (for step 3) are:
*AllowDebug - enables access to the debug page which is located at ~/ClickTaleDebug.ashx. Set to "true" to enable this functionality.
*LogFileNameMask - holds the path to the location where the log files are created. Normally in the form LogFileNameMask="~\ClickTaleLog{0}.txt" (where {0} is the current date). The log file has to be enabled for writing by IIS/ASP.
*DebugCode - enables some extra logging of each read and write events in the module. Used to debug difficult cases. The log must also be enabled for this to work correctly. Set to "true" to enable this functionality.
If you don't see the tracking code in your pages, please enable the debug page and try to access it. If you are getting broken recordings, please see the next section for possible causes.
===Load Balancing Scenario===
The module uses local storage for storing the temporary cache of pageviews content. That content is later requested by ClickTale servers via HTTP(S).
When using more than one server and using a load balancer to distribute the requests across the servers there is a chance that a visitor will be forwarded to a different server than the one to which the ClickTale crawler will be forwarded to. As a result the crawler will hit a server that doesn't contain the requested information and the recording (not the response to the visitor) will fail with a 404 error.
A proper load balancing configuration should implement one of the following
* A way to force the request form ClickTale to reach a specific server in the farm
* A cache store that is centralized

====Forcing a specific server====
=====Using direct host for fetching=====
If you have a dedicated host for each server in the farm, and you can access resources of the web site by going to a direct url, then you can set ClickTale to fetch from a specific server. To do that you would customize the [[ClickTaleFetchFrom]] url of each server to specify a direct url to that server.
For example if having a site '''<nowiki>http://www.site.com/</nowiki>''' and servers '''<nowiki>http://s1.site.com/</nowiki>''', '''<nowiki>http://s2.site.com/</nowiki>''' then you would change the bottom tracking code on each server to have [[ClickTaleFetchFrom]] url refer to the specific server directlylike this:
For the first server:
<source lang="javascript">
ClickTaleFetchFrom="http://s1.site.com/ClickTaleCache.ashx?t=%CacheToken%";
</source>
For the second server:
<source lang="javascript">
ClickTaleFetchFrom="http://s2.site.com/ClickTaleCache.ashx?t=%CacheToken%";
</source>
and so on.

=====Using cookies for accessing a specific server=====
Some load balancers use a HTTP cookie to assign a specific visitor to a specific server permanently. This is often called "Sticky sessions".
If you know that such cookie exists in your case, you should be able to cause the crawler to reach the original server if you record the cookie value.
This is done using the [[FetchFromWithCookies]] API.
To do so, change the ClickTaleFetchFrom line to:
<source lang="javascript">
ClickTaleFetchFromWithCookies.setFromCookie("[!COOKIENAME!]");
ClickTaleFetchFrom=ClickTaleFetchFromWithCookies.constructFetchFromUrl("http://%RootPath%/ClickTaleCache.ashx?t=%CacheToken%");
</source>
Where [!COOKIENAME!] is the name of the cookie that maintains the visitor's affinity to a specific server.

====Centralized cache store - Caching Content To a Database====
By default, the cached pages are stored in the application's cache object in server's memory. However, in some cases local cache may not be suitable (e.g. load balancing scenario). For such cases the module has a feature that enables storing cached pages in a database. Please follow these steps if you need to turn this feature on:
#Run a script named "ASP.NET Integration Module SQL Script.sql". This will create the database, table and stored procedures needed. This script can be found in the downloaded zip.
#Add a new connection string that will connect to the new "ClickTale" database, name it "ClickTale".
#Add ConnectionStringName="ClickTale" and MaxCachedSeconds="240" attributes to the ClickTale.IntegrationModuleSettings element in the web.config file. You may also remove MaxCachedPages, because the database mode uses MaxCachedSeconds for cleaning instead.
MaxCachedSeconds represents the number of seconds a cached page will be stored in the database. Entries older than MaxCachedSeconds will be deleted when new entries are inserted. An example of a connection string and a configuration element:
<source lang="xml">
<connectionStrings>
<add name="ClickTale" connectionString="Data Source = .\SQLEXPRESS; Initial Catalog = ClickTale; User Id = User; Password = Pass; MultipleActiveResultSets = True" providerName="System.Data.SqlClient" />
</connectionStrings>
<ClickTale.IntegrationModuleSettings
ScriptsFile="~\ClickTaleScripts.xml"
MaxCachedSeconds="60"
LogFileNameMask="~\ClickTaleIntegrationModule_{0}_log.txt"
AllowedAddresses="75.125.82.64/26 50.97.162.64/26"
ConnectionStringName="ClickTale"
DoNotProcessCookieName="WRUID"
DoNotProcessCookieValue="0" />
</source>

===Use With "Expires" Header And Enable Reuse Of Cached Pages (if you are getting 404 errors for some of the pages of some of the visitors)===
Some websites use "cache-control" and "expires" headers to cache pages on the client. This improves performance but may be problematic when used with our module.

Pages are removed from the module's cache right after they are being accessed (for security and performance reasons). So, if a visitor browses a page more than once without refreshing the content from the server (usually a result of using the back button), ClickTaleCache.ashx will be called several times with the same token. This will cause a cache miss for any request beyond the first one.

To overcome this problem, it is possible to use the DeleteAfterPull="false" parameter in the configuration. This will disable the removal of cached pages when ClickTaleCache.ashx is called. Cached data will be removed after MaxCachedPages="???" new pages are cached, so you might want to extend this parameter as well to allow sufficient traffic between the first pageview and the next (duplicate pageview).

Additionally, you can change your HTTP cache control to "no-cache" which might be more correct for your application logic in the first place.

Please note that "DeleteAfterPull" is not available when caching content to database storage. To achieve the same effect with a "database cache", please edit the "CachePullCachedPage" SP of the ClickTale cache database and change it to only perform: "SELECT Page FROM CachedPages WHERE Token = @Token" . Use "MaxCachedSeconds" parameter instead of "MaxCachedPages" to control the period of time for which to keep the content in cache.

===IIS 7 Compatibility===
Sometimes there is another step that IIS7 users should perform. If ClickTale Integration Module does not work, please add the following line to your "web.config" file:
<source lang="xml">
<add name="ClickTaleIntegrationModule" type="ClickTale.IntegrationModule.ClickTaleIntegrationModule" preCondition="managedHandler" />
</source>
This line should go inside
<source lang="xml">
<system.webServer>
<validation validateIntegratedModeConfiguration="false" />
<modules>

</modules>
</system.webServer>
</source>

===Using with a (reverse) proxy server===
If you are using a (reverse) proxy server, that server could change the request in such a way that they seem to appear to originate from the proxy and not from ClickTale servers. This will prevent the module from authenticating the request based on IP address.
There are two ways to work around this.
* Change the allowed addresses (“AllowedAddresses”) value in the configuration section of ASP.NET module in your web.config file and set it to the IP of the proxy. Then you need to configure your proxy to block access to ClickTaleCache.ashx file and only grant access from IPs "75.125.82.64/26 50.97.162.64/26" (note, this stands for 75.125.82.64 - 75.125.82.127 and 50.97.162.64 - 50.97.162.127 using CIDR notation).
* or
* If your proxy includes the original IP address in the HTTP headers, then you can add a module setting in your web.config file to instruct the module to use that header. If your proxy uses a header field called "X-Forwarded-For" (this is common), then add IPAddressHeaderFieldName="X-Forwarded-For" to your web.config file to utilize this field.

===Conflicts with other modules===
In some cases, conflicts can occur with other modules that you may have on your site. This is usually an issue to consider if you are using compression modules rather than IIS built in compression.
The conflicts can often be solved by making sure that the ClickTale module is installed on top of the filter chain, such that it can handle the content first. To achieve that try:
a) to add the ClickTale Integration Module httpmodule entry as last in the list of modules.
b) if 'a' doesn't resolve the issue, try FilterInstallEvent="PostReleaseRequestState" as one of the configuration attributes of the module.

In some cases a CMS will prevent access to our "virtual urls" ClickTaleDebug.ashx or ClickTaleCache.ashx. For example, it might redirect them to a custom not-found page. If you suspect that this is the case, please contact support and request help with setting up "stand alone ASP.NET IM handlers".

If you try browsing to ClickTaleCache.ashx and get a CMS-generated error page, try creating a ClickTaleCache.ashx file (in the root) via Visual Studio and then paste in to the ProcessRequest method the following code:
<source lang="csharp">
ClickTale.IntegrationModule.ClickTaleIntegrationModule ct = new ClickTale.IntegrationModule.ClickTaleIntegrationModule();
ct.HandleClickTaleCacheRequest(context.ApplicationInstance);
</source>
This should manually run the handler without relying on the httpModule which may not be working because of the CMS. This works for Sitecore CMS.

===Multiple domains (inc. TLD)===
When migrating from Staging into Production the RootPath can bind to the first request loaded into the app cache (i.e. the first host requested) eg. there can be over a dozen TLDs (hosts) utilising the same app pool in larger sites:

In such cases the line:
<source lang="xml">
ClickTaleFetchFrom="http://%RootPath%/ClickTaleCache.ashx?t=%CacheToken%";
</source>
can be edited to read:
<source lang="xml">
ClickTaleFetchFrom="http://"+ document.domain +"/ClickTaleCache.ashx?t=%CacheToken%";
</source>
This should prevent the ClickTale bot querying the same domain for all cached items

==Q&A==

===I have already defined caching correctly on my server. I don't want to change the caching of my pages. Why do you add caching?===
The module caches the content of the pages for its own use. This cache has no effect on the delivery of the pages to the visitors, not does it change your existing server side or client side cache scheme. This is a separate cache designed to hold the content temporary in memory until our servers request it from the module.

==="Parser Error Message: Exception creating section handler" configuration error is displayed when trying to view pages on the website.===
Open your web.config file and change this:
<source lang="xml">
<configSections>
<section name="ClickTale.IntegrationModuleSettings" type="System.Configuration.SingleTagSectionHandler" />
</configSections>
</source>
:to this:
<source lang="xml">
<configSections>
<section name="ClickTale.IntegrationModuleSettings" type="System.Configuration.SingleTagSectionHandler, System, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"/>
</configSections>
</source>

===Are cached pages protected from access by third parties?===
Yes, several layers of protection are in place. Only certain IPs are allowed to request the cached pages (IPs of ClickTale servers) and only processes which already have access to the page have the secret token required to request the cached content.

===Is it possible to inject the script in other places rather than after/before body tags?===
Yes. By default the top script is injected after <body> and the bottom before </body>, but this can be changed by adding a InsertAfter attribute to the script[name="Top"] element or adding a InsertBefore attribute to the script[name="Bottom"] element, both are regular expressions.

===There is a specific page that I don't want recorded, but the module adds ClickTale script to every page.===

The ASP.NET Integration module is a site wide module that will process all pageviews on your site and try to inject the configured ClickTale code into them.
You will have to use one of the following solutions to ignore one or more pages (Please note that the first metho is dependent on the content of the page while the second method is dependent on the url of the page):

*You can configure the module to ignore some pages by using the DoNotReplaceCondition attribute on a script element in ClickTaleScripts.xml file. This property is a regular expression, when there is a match for this expression with page content on the page near the InsertBefore/InsertAfter condition, the script will not be added. Make sure that all pages you want to exclude match this condition. For example you can add a note in a HTML comment before the </body> tag that will function as a "do not replace" condition.

:What you will do is:
:1. Modify your ClickTaleScripts.xml file to have the "DoNotReplaceCondition" property like this:
<source lang="xml">
<script name="Bottom" DoNotReplaceCondition="">
<![CDATA[</source>
:2. Modify the pages you want to exclude to have the condition right before the </body> tag like this:
<source lang="xml"> 
</body>
</html></source>

:When the module will detect this text it will not inject the ClickTale code.

:You can also use this mechanism for other strings and conditions you might find in your code. For example, if you only want to include the Clicktale code in pages containing a word or string you can use the code below. For instance it is possible to only record users that are logged in by using a word like: "logout".
<pre>
DoNotReplaceCondition="^(?![\s\S]*word)"</pre>

*The latest versions of the module allow you to define WhitelistURLRegex and BlacklistURLRegex regular expression values in the configuration section. The regular expressions will be matched against the full url of the page. If a white-list is present, then the tracking code will be injected only into urls that match the white-list expression. If a black-list is present, then the tracking code will be injected only into urls that don't match the black-list expression.<br>
Let's say you want to whitelist two pages: page1.aspx and page2.aspx
So you would need to put into the the module's configuration section in the web.config the following:
<source lang="xml">
WhitelistURLRegex="(page1\.aspx|page2\.aspx)"
</source>
To disable code injection for an admin part of the site/CMS the following example can be used.
<source lang="xml">
BlacklistURLRegex="(admin)"
</source>

*Another option, which is less recommended for ASP.NET, is to use the [[PHP control script]]. The [[PHP control script]] allows you to set a list of pages to record or ignore and will require you to customize your ClickTale tracking code a little.

===Some of my pages already have the ClickTale script; I do not want the script to appear twice.===
You should either remove the script from those pages and let the module handle the insertion or you should use DoNotReplaceCondition. See the code step 2 for an example. The default script in Step 2 is already configured to prevent double inclusion.

===After installing the module, I tried to watch a recording but I got the following notice instead: "Request from an unauthorized IP." What should I do?===
This could be due to a misconfiguration, a proxy, a change in our IP addresses or a hacking attempt. Please check your settings, specifically "AllowedAddresses".

===I have installed the module but I don't see the tracking code in the source of the page. What is wrong?===
The module will only inject the code for visitors who are classified as "to-record" (have WRUID cookie with non-zero value) or for those who are not classified (no WRUID cookie). Visitors who are classified as "not-to-record" will get no code.

===How can I disable the caching and leave only the script injection?===
Do note that disabling caching defeats the main purpose of the module and correct page content might not be recorded. The best practice for this case is to put the static tracking code in the website's template. If you still want to use the module for tracking code injection but not for content caching you can add DisableCache="True" to the ClickTale.IntegrationModuleSettings element in the web.config file. When setting DisableCache to True, you need to remove the ClickTaleFetchFrom line from the ClickTaleScripts.xml file or else nothing will be cached.

===I'm receiving "The resource cannot be found. Description: HTTP 404. The resource you are looking for (or one of its dependencies) could have been removed..." on my site root page once the module is installed. Full URLs that include the file name produce correct behavior.===
Please make sure that you are not using IIS6 with “Wildcard App Mappings” option enable in the IIS config of your site. Such a configuration is not supported by this module.

===I'm receiving "<i>Post cache substitution is not compatible with modules in the IIS integrated pipeline that modify the response buffers. Either a native module in the pipeline has modified an HTTP_DATA_CHUNK structure associated with a managed post cache substitution callback, or a managed filter has modified the response.</i>" on my site root page once the module is installed. ===
This happens because you are using post-cache substitution along with ClickTale integration module which is a response filter and they are not compatible.
<br>For more information please read http://support.microsoft.com/kb/2014472.
<br>ClickTale Integration module and post-cache substitution cannot work together.

===How is RootPath determined and how do I change it?===
The host (which is used for RootPath) is registered once when the module is first loaded. It changes when you restart the web server or when you make a change in the ClickTaleScripts.xml file. To change it back to the value you wanted please restart your web server, then access your site from a URL using the host you wish to serve as root path.

[[Category:Plugins_and_Integrations]]

ASP.NET integration code

2011-10-09T10:39:33Z

Shmuls:

{{SMB}}
<center><big>'''If possible, use the [[ASP.NET integration module]] instead. It provides better integration with our service.<br>
The only reason to use this code is if you are unable to install a binary module on your site.'''</big></center>

If your ASP.NET web site uses sessions (storing data in the Session[] object) or .NET's built-in Forms Authentication then ClickTale may not be able to record your pages correctly by default.
This code will provide you with an ASP.NET "Web User Control" that will not only allow you to add ClickTale easily to your pages, but will also allow ClickTale to do correct caching of "session" dependant and "Forms Authentication" protected pages.
This sample was developed and tested for ASP.NET 2.0 . It won't work with ASP.NET 1.x because the cookieless="AutoDetect" attribute is not supported prior to ASP.NET 2.0.
==Instructions==
===Step 1===
Modify your web.config file to allow cookieless session and authentication modes.
Find your system.web/authentication/forms tag and add an attribute that looks like this: cookieless="AutoDetect" .
Find your system.web/sessionState tag and add cookieless="AutoDetect" attribute too.
If you don't have one of those tags then you might be not using session or Forms Authentication or you may be using the default values. Add the tags when needed.
Here is an example of an XML snippet:
<source lang="xml"> <system.web>
<authentication mode="Forms">
<forms loginUrl="Login.aspx" protection="All" timeout="30"
cookieless="AutoDetect"
defaultUrl="~/admin/UserPage.aspx">
<credentials passwordFormat="Clear">
<user name="Arik" password="Password"/>
</credentials>
</forms>
</authentication>
<compilation debug="true"/>
<sessionState
mode="InProc"
cookieless="AutoDetect"
regenerateExpiredSessionId="true"
timeout="30" />
</system.web></source>

===Step 2===
Save the following block to the root of your website as ClickTale.ascx file
<source lang="asp">
<%@ Control Language="C#" ClassName="ClickTale" %>

<script runat="server">
// Copyright 2007 ClickTale Ltd.
private string FullUrl;

protected void Page_Load(object sender, EventArgs e)
{
string FullPath = Page.Request.Url.GetLeftPart(UriPartial.Path);
int ScriptNamePos = FullPath.LastIndexOf("/");
string VirtualPath = FullPath.Substring(0, ScriptNamePos + 1);
string ScriptName = FullPath.Substring(ScriptNamePos + 1) + Page.Request.Url.Query;

StringBuilder s = new StringBuilder(VirtualPath);
s.Append("(X(1)");
if (Page.Session.SessionID != null)
s.AppendFormat("S({0})", Page.Session.SessionID);
if (Page.Request.Cookies[FormsAuthentication.FormsCookieName] != null
&& Page.Request.Cookies[FormsAuthentication.FormsCookieName].Value != null
&& Page.Request.Cookies[FormsAuthentication.FormsCookieName].Value != "")
s.AppendFormat("F({0})", Page.Request.Cookies[FormsAuthentication.FormsCookieName].Value);
s.Append(")/");
s.Append(ScriptName);

FullUrl = s.ToString();
}
</script>


<div id="ClickTale" style="display: none;"></div>
<script src="http://s.clicktale.net/WRa.js" type="text/javascript"></script>
<script type="text/javascript">
ClickTaleFetchFrom='<%= FullUrl%>';
if(typeof ClickTale=='function') ClickTale([!YOUR PROJECT ID!],[!YOUR RATIO!]); // set your values here
</script>

</source>

You will need to insert your IDs and parameters in the bottom of the file. You should compare the code in the sample to the code you regularly use. Your code may be newer or better so you might want to edit the file to match.
Make sure you keep this line:
<source lang="asp">
ClickTaleFetchFrom='<%= FullUrl%>';
</source>
It is the one that does the magic.

===Step 3===
Add the "ClickTale Web User Control" to your pages. You can do that individually for each file or you can add the control to your master template (recommended).
To do that, add the line
<source lang="asp"><%@ Register Src="~/ClickTale.ascx" TagName="ClickTale" TagPrefix="CT" %>
</source>
at the top of your ASP file and
<source lang="asp"><CT:ClickTale ID="ClickTale" runat="server" /></source>
right before your </body> tag.

==Summary==
This add-on will allow ClickTale to impersonate the original visitor when caching the content. Implementing this process might have side effects on your site if you perform actions on GET requests. For example, if you keep a counter in your Session object which you raise for every page visit then you will now be getting an additional visit for every page that ClickTale is going to record. Generally you shouldn't have any such cases, but if you do you should check if ClickTale is making the request or a real person and handle properly. You can check that by looking for "ClickTale" in the UserAgent of the request.

[[Category:Plugins_and_Integrations]]

Template:SMB

2011-10-09T10:37:58Z

Shmuls: Created page with '<center><blockquote style="background: white; border: 1px solid rgb(153, 153, 153); padding: 1em; width:88%;">ClickTale Wiki<br>'''The instructions on th…'

<center><blockquote style="background: white; border: 1px solid rgb(153, 153, 153); padding: 1em; width:88%;">[[Image:Logo.png|30 px|ClickTale Wiki]]<br>'''The instructions on this page are intended for self service and online accounts.<br>Enterprise customers should contact their accout managers for integration support.'''</blockquote></center><br><br>

Ajax integration

2011-08-25T11:58:46Z

Shmuls:

ClickTale offers a comprehensive Ajax integration that fully supports session playback, visitor search and aggregated reports (Form Analytics, Heatmaps, etc). This integration allows ClickTale to run seamlessly on webpages built with Ajax, including dynamic pages and online forms.

'''Availability and functionality may vary based on your subscription level.'''

In order to use the ClickTale Ajax integration, you first need to contact a ClickTale Integration Specialist via our [http://www.clicktale.com/contact/contact_us?ct=(ajaxcustomer) contact us].

[[Category:Plugins and Integrations]]

Ajax

2011-08-25T11:58:26Z

Shmuls: Redirected page to Ajax integration

#REDIRECT [[Ajax integration]]

Ajax integrations

2011-08-25T11:57:43Z

Shmuls: moved Ajax integrations to Ajax integration

#REDIRECT [[Ajax integration]]

Ajax integration

2011-08-25T11:57:43Z

Shmuls: moved Ajax integrations to Ajax integration

Ajax integration

2011-08-25T11:57:32Z

Shmuls:

Privacy policy

2011-07-11T09:42:26Z

Shmuls:

ClickTale’s service is a web analytics service that monitors visitor interactions on a website. The ClickTale service, is added to a specific website by the website’s owner, it then records visitor interactions on the website enabling the website’s owner to receive various reports, including videos of users interactions and statistics based on such videos (the "Service").

This Privacy Policy outlines the information collected by the Service and how that information is used. In this Privacy Policy references to "we", "us" and "our" are to ClickTale Ltd.
__TOC__
==Collection of Information==
===What information we collect===
The information collected by our Service may include:
#Generic Characteristics of your computer such as: browser type, system language, OS version, time zone and screen resolution metrics.
#The web pages that you visit in a specific website and the URLs of the web pages that referred you to that website.
#Any mouse movements, mouse clicks and keystrokes on the visited website.
#Any information you enter and submit to a specific website. As a result, if you choose to supply personal information (such as, but not limited to, name, address or contact information) on a website, such information will be collected by the Service.
#Session information stored in cookies that are used to ensure accurate data is extracted from our systems.<br>
These cookies do not include any personal data.
===What information we do NOT collect===
#We do NOT collect any information about websites which do not use the Service.
#We do NOT collect any information about other programs that you are running on your computer.
#We do NOT assign a global unique identifier to you.
#We do NOT collect any passwords that you enter in a website.
#We do NOT collect key strokes that happen in fields that the website’s owner has marked as "sensitive".
===What we do with your information===
Any information we collect will be used in accordance with applicable laws for the following purposes:
#To provide website owners with raw or aggregate reports regarding visitor interactions on their website, that may include for example: aggregate reports of clicking or mouse movement activity, aggregate reports of scrolling activity and recreation of visitor browsing sessions.
#ClickTale may use the information to perform anonymous aggregated web surfing analysis and statistical reports.
#For auditing, research and analysis to operate and improve ClickTale technologies and services.
#We may share information with third parties in limited circumstances, including, without limitation, when complying with legal requirements, preventing fraud or imminent harm, and ensuring the security of our network and services. We may further share certain pieces of aggregated, non-personal information, such as average page load time, or the number of pages processed by our system per day. Such information does not identify you individually.
#When you send email or other communication to ClickTale, we may retain those communications in order to process your inquiries, respond to your requests and improve our services.
#When we use third parties to assist us in processing your personal information, we require that they comply with our Privacy Policy and any other appropriate confidentiality and security measures.
Except as described herein, we do NOT:
#Disclose your information.
#Share your information with third parties.
==Information security==
ClickTale maintains a strict "no-spam" policy. Your e-mail address will not be sold, rented or otherwise delivered to any third party unless it is so required with respect to the Service as described below.
We take appropriate security measures to protect against unauthorized access to or unauthorized alteration, disclosure or destruction of data. These include internal reviews of our data collection, storage and processing practices and security measures, as well as physical security measures to guard against unauthorized access to systems where we store personal data.
We restrict access to personal information to a limited number of ClickTale employees, contractors and agents who need to know that information in order to operate, develop or improve our services. These individuals are bound by confidentiality obligations and may be subject to discipline, including termination and criminal prosecution, if they fail to meet these obligations.
If you wish, you can select to be excluded from monitoring by our service by following this link: http://www.clicktale.net/disable.html.
When we receive formal written complaints posted using our contact form, it is ClickTale's policy to contact the complaining user regarding his or her concerns. We will cooperate with the appropriate regulatory authorities, including local data protection authorities, to resolve any complaints regarding the transfer of personal data that cannot be resolved between ClickTale and an individual.
==Policy Modifications==
We may change this Privacy Policy from time to time. If and/or when ClickTale makes changes to this Privacy Policy, the updated version will be posted on this page. We encourage you to visit this page periodically.
==Contacting us about Privacy==
If you have any questions about our privacy statement, the information we have collected from you online, the practices of this website, or your dealings with this website, please contact us by using our contact form.

Fetchfromwithcookies

2011-07-02T21:52:04Z

Shmuls: Redirected page to ClickTaleFetchFromWithCookies

#REDIRECT [[ClickTaleFetchFromWithCookies]]