Urchin - Installing the optional Urchin Tracking Module (UTM)

Portions of this section courtesy of and copyrighted by Urchin Software Corporation.

"There are two components to the Urchin Tracking Module System: the UTM Sensor, which is a lightweight module installed into the content of the website; and the UTM Engine which is part of the log processing Urchin Engine. The UTM Sensor enables client-side data collection, which is then funneled back through the web server augmenting the normal logfile. The client-side information is combined with the existing server-side data by the UTM Engine to provide a more accurate and complete picture of web site activity.

The UTM Sensor is a small amount of JavaScript code that accomplishes two important functions. First, the Sensor negates the effects of caching by forcing at least one hit to progress to the original web server for each pageview. The impact on the server is minimal, and the details about the additional hit are logged into the normal web log files resulting in a more complete data set. Secondly, the UTM Sensor uniquely identifies each visitor by using client-side cookies to keep track of the first time and returning visitors. The cookie identifier is a communication tag only viewable to your web server in the same nature as session ids. It is not a third party cookie, which provides information outside your system, violating many privacy policies."

For more detailed information on the UTM, including server-side operation and implementation, see the Urchin Tracking Module Whitepaper.

Installation of the UTM Sensor involves two basic steps:

• First, you must enable UTM and download the necessary files.

• Second, you must install the UTM Sensor into your HTML content.

Detailed instructions for completing both of these tasks follow.

In order to enable the UTM, you must have already upgraded your statistics to Urchin by requesting it within SiteEasy. For details on requesting and activating features, see the Adding and removing plan features.

To enable UTM and download the necessary files:


  1. In SiteEasy, select the Website Tools section and then click Advanced Website Statistics. The Urchin page appears.

  2. In the Default Document field, enter the name of your default Web site page (home page).
  3. Select Enable button to enable the UTM tracking module.
  4. Download the Urchin_UTM.zip file to your local computer. You can find this file at http://help.easyhost.com/utm/Urchin_UTM.zip.
  5. Continue with the next section.

To insert the UTM Sensor into your HTML content:

You must insert the JavaScript and GIF components of the UTM Sensor into the HTML content of your site. To ensure the most accurate reporting possible, you must insert this in every page of your site.

Both pieces necessary for completing this step are included in the Urchin_UTM.zip file you downloaded in the previous section. Within this Zip file, locate the following two files:



Upload both of these files to the root directory (www/) of your web site. Be sure that you do not change the names of these files.

Once these files are in place, you need to include the __utm.js file at the beginning of each Web page within your Web site. If your site uses server-side includes and you use a header include for each file, you can include the UTM in the beginning of this include file only. It will then automatically be a part of each Web page. For static HTML sites that do not use includes, you need to modify and add the UTM entry to each page individually. For dynamic sites that use a content-generation engine, the UTM can be included at the beginning of the template that is delivered to the visitors.

Regardless of which method you use, the following line of code should be included in the beginning of each HTML page that is delivered to the visitor. Note that there are two underscores at the beginning of the file name.

<script src="/__utm.js"></script>

(...existing content....)


If you have chosen to place the __utm.js file in a location other than your root directory (www/), be sure to make the appropriate changes to the src attribute of the <script> element.