Configuring the Webtrends Analytics App

Once the app is deployed, various customization and configuration options are available to the user. This section of the Implementation Guide describes these options. The configuration topics are broken into four categories:

  • General
  • SharePoint
  • User Profile
  • Plugins

Any changes to these options are not applied until the user clicks Save.

In the General section, you are able to set options that would be available to any website, and are not specific to SharePoint.

  • Data Collection URL – This field allows you to specify what data collection server the app will send data to. It defaults to statse.webtrendslive.com.
  • DCSID – This field allows you to specify what DCSID to send the collected data to. Webtrends data collectors required a valid DCSID to log any sent data. DCSID’s are generated by the Webtrends UI during the creation of new data sources in A9 or the creation of new Site Spaces in A10. If you do not have a valid DCSID, contact your Webtrends administrator.
  • Time Zone Offset – This field specifies the default time zone for the Site Collection. Note that the Webtrends.js files will auto-detect time zone settings from visitors’ browser as well.
  • Enable Tracking – This check box enables or disables tracking in the Webtrends app. The app deploys with tracking disabled by default. You must provide a valid DCSID. Then check Enable Tracking and then click Save to start sending data to Webtrends. Once this box is checked and saved, all pages in the Site Collection and its subsites will include the Webtrends tracking code (including subsites and pages added at a later date).
  • Download types to track – The list of file extensions that the scripts consider a ‘download’ are specified here.
  • Use hosted webtrends.js – Checking this box uses the webtrends.js found at http://s.webtrends.com/js/webtrends.js. Otherwise, a local copy will be used. This is the default configuration of the app. If your SharePoint install is locked down and you can’t use .js files from a remote source, uncheck this box.
  • Enable i18n – Check this to enable internationalization in the Webtrends tracking code.
  • Save – Commit current the app configuration to the live app. Under the SharePoint tab, you have options to enable and disable tracking of certain SharePoint features as well as specify the element information that the Webtrends SharePoint plugin looks for that information in.
  • Collect User Name? – Check this to retrieve the user name from the HTML code of the page.
  • User name element ID – This sets the element ID to look for the user name in. The default is determined by the version and environment of SharePoint and will not appear if Collect user name? is not checked.
  • Alternate user name element ID – If multiple design layouts are being used, a backup element ID may be provided for the user name. This option will not appear if Collect user name? is not checked.
  • Collect content information – Check this to enable the collection of content information within SharePoint.
  • Collect search information? – Check this to collect information about searches that users are performing.
  • Search box element ID – Specify the ID of the element that provides the search information. This should not need to be changed as this is provided by SharePoint. This option will not appear if Collect search information? Is not checked.
  • Search Pages – This field allows a user to enter a comma delimited list of pages that contain search results so the Webtrends SharePoint plugin can properly execute its search tracking. This option will not appear if Collect search information? Is not checked.
  • Collect Breadcrumbs? – Check this option to collect the page’s breadcrumb.
  • Breadcrumb element ID – This field contains the element ID to use when collecting the breadcrumb. This option will not be available if Collect Breadcrumbs? Is not checked.
  • Collect Web Part impressions? – Check this to track impressions for Web Parts on pages.
  • Collect ECB menu clicks? – Check this to track clicks on the Edit Control Block menu links.
  • Collect list information? –Check this to collect information regarding lists.
  • Collect Social Menu clicks? – Check this to collect clicks on the social menu.
  • Collect all link clicks? – Check this to collect data for all link clicks via dcsMultiTrack on the links.

The User Profile tab will be different for each tenancy as almost every tenancy has different user profile properties available. This tab shows each property it is able to retrieve, along with an example value, a check box to enable that property’s collection, and a field to assign a Webtrends parameter to that field. The default properties that Webtrends collects are prepopulated. In order to collect additional properties, users will need to check Collect? as well as enter a parameter name into the Assigned Parameter field. The parameter name should begin with WT.shp_.

NOTE: None of these values will be collected and the user profile plugin will not even be loaded if “Collect user profile information?” is not checked at the top of the tab.

The final tab is the Plugins tab. Each plugin available for customization is shown on this tab. From here, a user can modify the settings for the plugin, aside from the src setting, and enable or disable the plugin. By default, the only available plugin is for Heatmaps and it is disabled by default.