Instrumentation Options for the Webtrends SharePoint Tags

There are 3 primary ways of deploying the Webtrends SharePoint tags into your SP2013, SP2016, or SPO environment.  Each provides the same underlying JavaScript tracking code, but allow for a more flexible implementation method depending on your company’s needs and capabilities:

  1. App/Add-in:
    1. The App (now referred to as an Add-in by Microsoft) can be installed into your environment’s app catalog, and deployed to each desired site collection.  The deployment can be accomplished using the Managed Paths option within the app-catalog settings, or by visiting each site collection and deploying it directly via the “add an app” link.  This Webtrends SharePoint Tag Installer app is available for download on the SharePoint tab here.
    2. The deployment of the app does not add the tracking JavaScript to the pages.  You must edit the app on each site collection and Enable Tracking to create the WebtrendsAssets folder and add a user custom action to the site collection which performs the insertion of the JavaScript files into a visitor’s browser.  Due to this limitation with add-ins and user custom actions, we have also created a free tool called the Webtrends SharePoint Tag Administrator, which allows you to deploy and enable the app on multiple site collections simultaneously.  Use of this tool bypasses the app catalog, and you should not deploy the app through the app catalog if you wish to utilize the administrator.  The Tag Administrator is also available for download on the SharePoint tab found here.  For more information about this tool, please see the official guide.
    3. This method is supported on SP2013, SP2016, and SPO.
  2. Manual Tagging:
    1. The JavaScript utilized by the app can be added to your pages directly without the use of the app by adding a <script> element to your pages that points to the appropriate Webtrends files.  This is typically done by editing the master page and adding a script line, but could also be accomplished via a Script Editor web part (which would need to be added to all pages), or as additional JavaScript within a file that is already in use on the entire site, such as a branding script.  Note that some pages utilize different master pages, and each would need to be identified and edited.  Additionally, inheritance can be broken so that sub sites do not receive the same master page as the parent site, and editing of their respective master pages would be required.
    2. You can obtain the necessary Webtrends JavaScript files by downloading the app from the SharePoint tab found here, and then extracting the contents of the zip file.  The associated files are located in the root of the .zip file for your convenience.  You must configure the webtrends.load.js file directly with the appropriate settings prior to uploading to your site for deployment.
    3. This method is supported on SP2013, SP2016, and SPO.
  3. WSP Feature:
    1. Webtrends can provide a WSP (Windows SharePoint) feature that contains the associated JavaScript files and enables tracking at a variety of scopes.  The feature package can be configured at the Farm, Web Application, or Site Collection scope, depending on your preferences.
    2. Configuration of the JavaScript files must be completed prior to deployment of the .WSP file.  This is generally done through Webtrends support, or you must manually configure the files and properly repackage the .WSP before deployment to your environment.  It is recommended that you reach out to your Account Manager to obtain a WSP for your environment if you wish to utilize this method of deployment.
    3. This method is supported on SP2013 and SP2016.