Viewing Page-Level Analytics from the Site

Any authorized user can view analytics for a page on your website by following these steps.

1. Log into the website.
2. Navigate to the page whose analytics data you wish to view.
3. Hover the cursor over the Website Content menu.
4. Choose View Page Activity. The SEO page’s Traffic tab appears.
   —Image—

   

The Traffic tab of the SEO control graphs the analytics data of any 2 search criteria. Below the graph is data for the 5 visit criteria tracked by the analytics provider.

• Pageviews—number of pageviews for this page over the selected date range
• Unique pageviews—number of unique visitors to this page over the selected date range
• Average time on page—how long a visitor spent on the page. It is calculated by subtracting the initial view time for this page from the initial view time of the subsequent page. So, this metric does not apply to exit pages.
• Bounce rate—the percentage of single-page visits (that is, visits in which the visitor exited your site from the entrance page)
• % Exit—the percentage of site exits that occurred from this page

You can change the date range, analytics provider, and either search criterion (Pageviews and Time on Page in the example above).

You can also replace the URL with a different one, and view the page being analyzed (by clicking Visit this page in the green bar).

Viewing Page-Level Analytics from a PageBuilder Page

Any authorized user can view analytics for a PageBuilder page by following these steps.

NOTE: You cannot drag and drop the Analytics widget onto a PageBuilder page.

1. Open the PageBuilder menu. See Also: Creating Web Pages with PageBuilder
2. From the menu, choose View > Analytics. The SEO page’s Traffic tab appears.

Viewing Page-Level Analytics from the Workarea

The Workarea provides 2 page-level views of analytics data.

• The View Content History screen—compares analytics data for any 2 published versions
• The Analytics toolbar button—displays the SEO page’s Traffic tab.

To view a content item’s analytics data from the Workarea:

1. Navigate to the folder containing the content whose analytics data you want to view.
2. Click the content item.
3. To compare analytics data between any 2 published versions, click History().
   See Also: Comparing Versions of Content

   To view analytics for the currently published version, click Analytics (). When you do, you see the Traffic tab of the SEO page.

On the View Content History screen, blue and orange radio buttons appear next to each published version of content.

To compare analytics data, click the appropriately-colored radio button next to each version, then click Compare (). The Compare screen for the 2 versions appears.

You can change the date range for each content version. You can also:

• Use the Display pull-down to graph any visit data.
• Click the URL Filtering tab to select the URLs being displayed. See Also: URL Filtering
• Select a different site
• Select a different analytics provider
• Use the Segments button ().

URL Filtering

Any content item can be viewed via several URLUniversal Resource Locators, such as

• its quicklinka special kind of hyperlink that jumps to another content item on your Web site. (A regular hyperlink jumps to a Web page on the internet.). See Also: Adding a Quicklink or Form to Content
• manual alias
• automatic alias See Also: Creating User-Friendly URLs with Aliasing

NOTE: While Regex-based aliases affect Analytics data, they do not appear on the URL Filtering tab.

The URL Filtering tab of the Compare Analytics screen lets you analyze the data by each identifier. So, for example, you can drill down to view only the data collected when site visitors accessed a page by typing its manual alias into the browser.

Analyzing Site Statistics

The following table shows analytic statistics available for each level of the site.

Type of Statistical Information	Site-wide	Template- Level	Content- Level
Views of Any Template
Visitors: New and Return
Pie Chart of New vs. Return Visitor
Pie Chart of Views/Visitors Ratio
Bar Graph of Views/Visitors Ratio
Visited Pages
Visited Content Blocks
URLs from which Site Visitors Accessed Ektron

Tracking New and Returning Site Visitors

The Business Analytics feature provides information about visits made by new versus returning visitors. To capture this data, the feature asks this question whenever a page is visited: is the user logged in as either a membership or regular user?

• If yes, capture the user ID with the statistical data
• If no, place a cookie on the visitor’s computer

The next time the user visits that page, the feature checks the visit history for the user ID, or for a cookie. If either is found, the visit is considered a return.

The same user visit may be considered new on one view but not on another. For example, someone visits on January 30 (Monday) then again February 2 (Thursday). On the monthly statistics, that visitor is new, but on the weekly statistics, the February 2 hit would be a return visit (his second this week).

Now consider a second visitor, who browses to your site on the first and 20th of the month. These visits appear on weekly statistics as 2 new visits, but on the monthly statistics, only the first visit would show up on that month's tally of new visitors. The second visit would add to the return visitor statistics.

Specifying the Frequency of Writing to the Database

After you set up the Business Analytics feature, your database is subject to a continuous barrage of write activity, generated by visits to your site. To optimize your database’s performance, you can hold visit activity in application server memory until a predetermined amount of data is collected. When collected, it is moved in one packet to the database. So, the database is “hit” much less frequently.

Specify the amount of data saved in memory prior to being written to the database using these web.config file elements.

• recordsBeforeWrite—the number of unique template visits
• timeBeforeWrite—the number of seconds since the last time a database write occurred

When either element reaches the value set in web.config, all records stored in memory are written to the database. That event resets both elements to zero (0).

When you first view statistical data, the default date range is today (one day).

If you view statistics for different date ranges, when you return to the screen, the last selected date range is the default selection. You can change it if needed.

Using Quick View Options

Use Quick View options to view analytics for any of these time periods.

• one day
• one week
• one month
• one year

When you click Quick View [week], [month] or [year], the current end date is used as the last day of the range. Here are some examples.

• Week—If end date is today, begin date is one week earlier than today
• Month—If end date is today, begin date is one month earlier than today
• Year—If end date is today, begin date is one year earlier than today

Using Jump To Options

Use Jump To options to view statistics for a time period before and after the current date range. The time period is determined by the Quick View increment. For example, if the Quick View option is Day, you can jump to the previous day, the following day, or today.

Regardless of the Quick View increment, you can always view statistics for today.

Viewing Business Analytic Reports

The Business Analytics reports let you drill down from the entire site to individual templates to individual content items.

Prerequisite

In your site's web.config file, the ek_enableClassicAnalytics setting is set to true.

NOTE: The Most Popular and Trends widgets also report on Business Analytics data. See Most Popular Widget and Trends Widget.

To access Business Analytics Reports:

Either

1. Browse to a content item for which Business Analytics data is being captured.
2. Right click the mouse.
3. Choose View Template Activity to see Business Analytics data for the current content item (to learn more about data captured for one content item, see Content View).
4. Choose View Site Analytics to view Business Analytics data for the entire site.

or

• From the Ektron Workarea, choose Reports > Business Analytics to view analytic data for the entire website. The following reports are available.
  • Site Statistics View
  • Content View
  • Templates View
  • Referrers View

Most Popular Widget

The Most Popular widget reports on these categories of content on your website. By default, every Most Popular widget tab shows up to 5 results.

• Most Viewed
• Most Emailed
• Most Commented
• Highest Rated

You can place the Most Popular widget onto any PageBuilder page. See Also: Creating Web Pages with PageBuilder

NOTE: You cannot place more than one Most Popular widget on a PageBuilder page. Also, you can hide up to 3 tabs if you do not want all of them seen.

The Most Popular widget references content events, which areEktron events that are tracked when used with various server controls. Here are 2 examples of a content event:

• for the Most Viewed tab, the content was viewed and tracked by the Analytics Tracker server control. See Also: Analytics Tracker
• for the Most Emailed tab, the content was emailed from the Social Bar server control

The Most Popular widget displays content items that meet these criteria.

• the content is tracked by a server control
• content events occurred within the date range set in the Most Popular widget properties. The default value is 7 days, but you can change it if desired. See Also: Viewing Business Analytic Reports
• the content is assigned to a selected folder or taxonomya content-level categorization system that uses one-to-many relationships (such as Ronald Reagan is to Actor, Governor, and President) to create a scalable organization of content. A taxonomy lets your site visitors navigate content independent of the folder structure.. By default, the widget has no folder or taxonomy restrictions. But the properties screen lets you restrict results by folder or taxonomy.
• the content is among the highest rated content items for that tab.

  For example, if the Most Viewed tab shows the top 5 content items (the default setting), content that has not been viewed as frequently as the top 5 does not appear. Consider the following example.

  Content ID	Number of Times Content Viewed within Date Range
  30	87
  259	82
  316	78
  12	78
  658	67
  243	62

  In this case, content ID 243 does not appear on the Most Popular widget because it is sixth in the frequency of viewing rank.

Each time a content item is used with one of the following server controla server control uses API language to interact with the CMS and Framework UI to display the output. A server control can be dragged and dropped onto a Web form and then modified.s, its count for that day is incremented by 1.

• Analytics Tracker—Most Viewed tab—A site visitor browses to a page that is tracked by the Analytics Tracker server control. The control lets you determine which content is counted when the page is viewed.
• SocialBar—Most Emailed tab—A community group member browses to a page that hosts the Social Bar server control, and emails a content item to a friend. (The SocialBar server control must be associated with content.)
• MessageBoard—Most Commented tab—A Community Group member browses a page that hosts the Message Board server control and comments on a content item on that board. (The MessageBoard server control must be associated with content.)
• ContentReview—Highest Rated tab—A site visitor browses to page that hosts the Content Review server control, and uses the control to rate a content item.

Next to each content item is a count. The count indicates the number of times a content event occurred for that content item within the specified time frame. See Also: Viewing Business Analytic Reports

The date range may affect the count. For example, if a content item was viewed once a day for the past 10 days but the date range is set to 7 days, the count is 7. To change this maximum:

1. Open siteroot/widgets/mostpopular.ascx.cs.
2. Find the following line private int _PageSize = 5;.
3. Change the number at the end of the line to the maximum number of results to display.

   NOTE: This setting affects all tabs and instances of the Most Popular widget.

A logged in user can change the properties that determine what appears on the Most Viewed tab. To do so, click Edit ().

Trends Widget

By default, the Trends widget shows the Most Viewed content on your website. You can edit the widget's properties so that it displays any of the following categories of content instead.

• Most Emailed
• Most Commented
• Highest Rated

The Trends widget is a subset of the Templates View, so you should be familiar with that section before reading this. It explains topics such as how Ektron determines which content appears for each category. You can place the Trends widget onto any PageBuilder page. See Also: Developing Wireframe Templates

A logged in user can change properties that determine the appearance of the Trends widget. To do so, click Edit (). The Trends widget screen appears.

Business Analytics API

The Business Analytics API's namespace is Ektron.Cms.Framework.Analytics.BusinessAnalytics and consists of several static methods arranged into 2 groups:

• those that save events to the database
• those that retrieve the event data from the database for use in reports

NOTE: The demonstration code in this section uses C# syntax.

using Ektron.Cms.Framework.Analytics.BusinessAnalytics;
…
EventLogger.Log(“myEvent”);

IAnalyticsEventData eventObject = CreateAnalyticsEventData();

using Ektron.Cms.Framework.Analytics.BusinessAnalytics;
...
IList<String> names = EventReporter.GetReportNameList();

<section name="businessAnalyticsQueryProvider"
  type="Ektron.Cms.Analytics.Providers
    .BusinessAnalyticsQueryProviderConfiguration,
  Ektron.Cms.BusinessObjects"
  allowDefinition="MachineToApplication"
  restartOnExternalChanges="true"/>
<section name="businessAnalyticsEventProvider"
  type="Ektron.Cms.Analytics.Providers
    .BusinessAnalyticsEventProviderConfiguration,
  Ektron.Cms.BusinessObjects"
  allowDefinition="MachineToApplication"
  restartOnExternalChanges="true"/>

<businessAnalyticsQueryProvider
  defaultProvider="EktronBusinessAnalyticsQueryProvider">
  <providers>
    <add name="EktronBusinessAnalyticsQueryProvider"
      type="Ektron.Cms.Analytics.Providers.EktronQueryProvider,
      Ektron.Cms.BusinessObjects"/>
  </providers>
</businessAnalyticsQueryProvider>
<businessAnalyticsEventProvider
  defaultProvider="EktronBusinessAnalyticsEventProvider">
  <providers>
    <add name="EktronBusinessAnalyticsEventProvider"
      type="Ektron.Cms.Analytics.Providers.EktronEventProvider,
      Ektron.Cms.BusinessObjects"/>
  </providers>
</businessAnalyticsEventProvider

<businessAnalyticsQueryProvider
  defaultProvider="DemoQueryProvider">
  <providers>
    <add name="EktronBusinessAnalyticsQueryProvider"
      type="Ektron.Cms.Analytics.Providers.EktronQueryProvider,
      Ektron.Cms.BusinessObjects"/>
    <add name="DemoQueryProvider"
      type="Ektron.Cms.Analytics.Providers.DemoQueryProvider,
      CustomProviders"/>
   </providers>
</businessAnalyticsQueryProvider>
<businessAnalyticsEventProvider
  defaultProvider="DemoEventProvider">
  <providers>
    <add name="EktronBusinessAnalyticsEventProvider"
      type="Ektron.Cms.Analytics.Providers.EktronEventProvider,
      Ektron.Cms.BusinessObjects"/>
    <add name="DemoEventProvider"
      type="Ektron.Cms.Analytics.Providers.DemoEventProvider,
      CustomProviders"/>
  </providers>
</businessAnalyticsEventProvider>

Deciding Which Google Analytics Version to Use

Ektron supports Google Analytics versions 2.4 and 3.0. To compare versions, see Migration Guide: Moving from v2.3 APIs to v2.4 & v3.0 > Differences between v2.4 and v3.0.

You may use both versions. If you enable both, the Ektron Workarea displays a drop-down for choosing a provider. Data is the same for both providers if you use the same Google analytics profiles.

IMPORTANT: If you will use Google’s Core Reporting API v3.0, Ektron supports the ClientLogin and OAUTH 2.0 authentication methods.
If you will use Google’s Core Reporting API v2.4, Ektron only supports ClientLogin authentication.

Setting up Google Analytics

This section explains how to set up Google analytics. After you complete these steps, Google begins tracking your entire website. Alternatively, you can track individual site pages (see Tracking a Single Page), or clicks by file type (see Tracking Clicks by File Type).

Prerequisite

If you want to use OAuth2.0 authentication, follow the steps in Using OAuth2.0 as an Authorization Protocol before beginning this procedure.

WARNING! Enabling the tracking code may cause a significant increase in CPU usage.

1. Create a Gmail account (http://mail.google.com).
2. Sign up for Google Web Analytics (www.google.com/analytics/). When setting up a Google Web Analytics profile for your site, you are assigned a profile ID and a User Account. You need those to complete Step 8.
3. Open this Google Analytics help page: Migration Guide: Moving from v2.3 APIs to v2.4 & v3.0.
4. Under "Create a Project in the Google APIs Console," follow steps 1 through 4. On the API Access screen, under Simple API Access, click the Create new Browser key button. Copy the new browser key. This will be your API key in Step 8.
5. On the server that hosts Ektron, go to C:\Program Files\Ektron\CMS400vxx\Utilities\EncryptEmailPassword.exe.
6. Use that utility to encrypt the Gmail username and password that you obtained in Step 1. Enter the full user name, including @gmail.com.
7. Open your site’s siteroot/web.config file and find the AnalyticsDataProvider tag. If you enable versions 2.4 and 3.0, edit the GoogleV3.0 and GoogleV2.4 tags.

   <AnalyticsDataProvider defaultProvider="Google"> 
     <providers>
       <add name="GoogleV3.0" 
         type="Ektron.Cms.Analytics.Providers.GoogleAnalyticsProviderv3,
         Ektron.Cms.BusinessObjects"
      EmailAddress="" 
      KeyFilePassword="" 
      KeyFilePath="/Key/privateKey/xxxxxxxxx.p12" 
      Username="" Password="" ProfileId="" 
         SiteURL="" UserAccount="" 
         Endpoint="https://www.googleapis.com/analytics/v3/data/" 
         ApiKey="" CacheInterval="0" 
   GoogleAnalyticsTrackingCodePath="Analytics\template\googletrackingcode.ascx" 
         Version="3.0" />
       <add name="GoogleV2.4" 
         type="Ektron.Cms.Analytics.Providers.GoogleAnalyticsProvider, 
         Ektron.Cms.BusinessObjects" Username="" Password="" ProfileId="" 
         SiteURL="" UserAccount="" 
         Endpoint="https://www.googleapis.com/analytics/v2.4/" 
         ApiKey="" CacheInterval="0" 
   GoogleAnalyticsTrackingCodePath="Analytics\template\googletrackingcode.ascx"
         Version="2.4" /> 
     </providers>
   </AnalyticsDataProvider>

   NOTE: If your web.config has several analytics providers and you want to turn off analytic tracking for one of them, delete the value of the GoogleAnalyticsTrackingCodePath property.

8. Complete each tag’s properties.
   • name—The free text name of the site being tracked and the Google version. You should use the site name followed by provider name and version. For example, www.ektron.com-Google V3.0. When Workarea users view site-level displays of Web Analytics data, they choose the site from a drop-down. If you change the name, you must also change the <AnalyticsDataProvider defaultProvider element to match the name.

     

   NOTE: The following three fields are used only if you are using OAuth 2.0 authentication.

   • EmailAddress—Enter the service account email address that you used to register your site in the Google Console.
   • KeyFilePassword—Is displayed in the Download dialog that appears while registering your site in the Google Console.
   • KeyFilePath—Enter the path to the privatekey file that you downloaded and saved while registering your site in the Google Console.
   • Username—The Gmail username you encrypted.
   • Password—The Gmail password you encrypted.
   • ProfileID—The Google Analytics Profile ID you obtained in Step 2. Another way to find your Profile ID is to go to Google Analytics and click Analytics Settings. Next Edit a website profile. The Profile ID shows under the Profile Settings Title.

     NOTE: Tip! On the Google Analytics settings page, in the address bar, the &id= value is your ProfileId.
     
     

   • SiteURL—Your site root name. For example, you could set up one <providers> tag for the developer.ektron.com site, and another for the synergy.ektron.com site. The SiteURL needs to match the development site URL when you test in your development environment. For example, if the site path is http://MyDevMachine/default.aspx, the SiteURL is MyDevMachine. If there is no match, the Google beacon is not inserted onto your page.
   • UserAccount—The Google Analytics SiteURL you obtained.

     NOTE: Tip! When you visit your Google Analytics Settings page at google.com, the UA-xxxxxx-x string next to your site domain is the UserAccount assigned by Google.

     NOTE: To track multiple providers or sites
     1. Copy the <providers> tag.
     2. Paste it below the existing tag and above </AnalyticsDataProvider>.
3. Modify the elements.

   • API key—Insert the API key that you created in Step 4.
9. Within the web.config's <analyticsSettings> tags is a suppressBeacon element that lets you track or suppress the tracking of users on your website. Many site administrators do not want to track user behavior in Traffic Analytics reports, as it corrupts the data. (This setting does not apply to Business Analytics.) See Also: Analyzing Websites. Here are the possible values for this element.
   • None—Track all users, including authenticated membership and Ektron users.
   • Members—Track unauthenticated and logged-in Ektron users only. Do not track membership users.
   • Authors—Track unauthenticated and logged-in membership users only. Do not track Ektron users.
   • All—Track unauthenticated users only. Do not track membership and Ektron users.
10. Within the web.config's <appSettings> tags is an ek_AutoInsertBeaconScript element that either tracks or suppresses tracking activity on your website. Change its value to true.
11. Save web.config.

    IMPORTANT: No server control is needed to track Web Analytics. After you enable Web Analytics in the web.config file, the following JavaScript is automatically added to each PageBuilder page and any site page that contains an Ektron server control.

    <%@ Control Language="C#" 
      AutoEventWireup="true" 
      CodeFile="googletrackingcode.ascx.cs" 
      Inherits="Analytics_Template_GoogleTrackingCode" 
      EnableTheming="false" EnableViewState="false" %> 
    <!-- Start Google Code --> 
    <script type="text/javascript"> 
      var _gaq = _gaq || []; 
      _gaq.push(['_setAccount','<asp:literal id="GoogleUserAccount" runat="server"/>']); 
      _gaq.push(['_trackPageview']); 
      <asp:literal runat="server" id="variables"/> 
        (function() 
          { var ga = document.createElement('script'); 
          ga.type = 'text/javascript'; 
          ga.async = true; 
          ga.src = ('https:' == document.location.protocol ? 'https://ssl' :
             'http://www') + '.google-analytics.com/ga.js';
          s.parentNode.insertBefore(ga, s);
            var s = document.getElementsByTagName('script')[0]; 
          }
        )(); 
    /* Start Track Event binding Code */ 
    //
    // extracted from 
    // http://runtingsproper.blogspot.com/
    //   2009/12/how-to-automatically-track-events-with.html 
    //
    // un-comment the below if you would like google analytics to track your pdf   
      // download links on the website. 
    //$(document).ready(function () { 
    // TrackEventsForClicks(); 
    //}); 
    // 
    //function TrackEventsForClicks() 
    //{ 
    // TrackEventByFileExtension(".pdf");
    // 
    // add your file extension here 
    //} 
    // 
    //function TrackEventByFileExtension(FileExtension) 
    // {
    // $("a[href$='" + FileExtension + "']").click(function() 
    //{
    // var fileURL = $(this).attr("href"); 
    // _gaq.push(['_trackPageview', fileURL]); 
    // }); 
    //} 
    /* End Track Event Binding Code */ 
    </script> <!-- End Google Code -->

Using OAuth2.0 as an Authorization Protocol

OAuth2.0, the next evolution of the OAuth protocol, lets you provide authorization flows for Web applications, desktop applications, mobile phones, and so on. Google APIs use OAuth 2.0 for authentication and authorization. Google has implemented an OAuth2.0 for access to its resources from the third-party applications, such as Ektron. It's secured, so that the client need not share user credentials with any third party applications. See Also: http://oauth.net/2/, https://developers.google.com/accounts/docs/OAuth2

Follow these steps to implement the OAuth2.0 authorization protocol for Google Analytics 3.0.

1. Create a Gmail account.
2. Sign up for Google Web Analytics (www.google.com/analytics/). When setting up a Google Web Analytics profile for your site, you are assigned a profile ID and a User Account. You need those to complete Step 17.
3. Open a browser and navigate to https://code.google.com/apis/console.
4. Click Create project.
5. In the left panel, click Services.
6. Turn on the Analytics API service. Agree to terms of service.
   —Image— 

   

7. In the left panel, click API Access.
8. Click the button Create an OAuth 2.0 client ID.
   —Image— 

   

9. A pop-up window opens. Register your site information. In the Home Page URL field, enter your website address.
10. The Create Client ID screen appears. Choose Service Account and click Create client ID.
11. The following screen appears. Click Download private key. Close the window.
    —Image— 

    

12. A key file is downloaded. Keep it in a secure directory. The file contains a private key that is unique per user. You need this information to complete Step 8 of Setting up Google Analytics.
13. The next screen displays your Client ID, email address and public key fingerprints.
14. On the server that hosts Ektron, go to C:\Program Files (x86)\Ektron\CMS400vxx\Utilities\EncryptEmailPassword.exe.
15. Use that utility to encrypt the Gmail username and password that you obtained in Step 1. Enter the full user name, including @gmail.com.
16. Open your site’s siteroot/web.config file and find the AnalyticsDataProvider tag. If you enable versions 2.4 and 3.0, edit the GoogleV3.0 and GoogleV2.4 tags.

    <AnalyticsDataProvider defaultProvider="Google"> 
      <providers>
        <add name="GoogleV3.0" 
          type="Ektron.Cms.Analytics.Providers.GoogleAnalyticsProviderv3,
          Ektron.Cms.BusinessObjects"
       EmailAddress="" 
       KeyFilePassword="" 
       KeyFilePath="/Key/privateKey/xxxxxxxxx.p12" 
       Username="" Password="" ProfileId="" 
          SiteURL="" UserAccount="" 
          Endpoint="https://www.googleapis.com/analytics/v3/data/" 
          ApiKey="" CacheInterval="0" 
    GoogleAnalyticsTrackingCodePath="Analytics\template\googletrackingcode.ascx" 
          Version="3.0" />
        <add name="GoogleV2.4" 
          type="Ektron.Cms.Analytics.Providers.GoogleAnalyticsProvider, 
          Ektron.Cms.BusinessObjects" Username="" Password="" ProfileId="" 
          SiteURL="" UserAccount="" 
          Endpoint="https://www.googleapis.com/analytics/v2.4/" 
          ApiKey="" CacheInterval="0" 
    GoogleAnalyticsTrackingCodePath="Analytics\template\googletrackingcode.ascx"
          Version="2.4" /> 
      </providers>
    </AnalyticsDataProvider>

    NOTE: If your web.config has several analytics providers and you want to turn off analytic tracking for one of them, delete the value of the GoogleAnalyticsTrackingCodePath property.

    NOTE: To track multiple providers or sites
    1. Copy the <providers> tag.
    2. Paste it below the existing tag and above </AnalyticsDataProvider>.
3. Modify the elements.

17. Complete each tag’s properties.
    • name—The free text name of the site being tracked and the Google version. You should use the site name followed by provider name and version. For example, www.ektron.com-Google V3.0. When Workarea users view site-level displays of Web Analytics data, they choose the site from a drop-down. If you change the name, you must also change the <AnalyticsDataProvider defaultProvider element to match the name.

      

    • EmailAddress—Enter the service account email address that you used to register your site in the Google Console.
      —Image— 

      

    • KeyFilePassword—Was displayed in the Download dialog that appears while registering your site in the Google Console (step 10 above).
    • KeyFilePath—Enter the path to the privatekey file that you downloaded and saved while registering your site in the Google Console (step 10 above).
    • Username—The Gmail username you encrypted in Step 14.
    • Password—The Gmail password you encrypted in Step 14.
    • ProfileID—The Google Analytics Profile ID you obtained in Step 2. Another way to find your Profile ID is to log into Google Analytics, go to the home page, click your root folder to reveal Analytics Settings. The Profile ID is next to your site name.
      —Image— 

      

    • SiteURL—Your site root name. For example, you could set up one <providers> tag for the developer.ektron.com site, and another for the synergy.ektron.com site. The SiteURL needs to match the development site URL when you test in your development environment. For example, if the site path is http://MyDevMachine/default.aspx, the SiteURL is MyDevMachine. If there is no match, the Google beacon is not inserted onto your page.
    • UserAccount—The Google Analytics SiteURL you obtained.

      NOTE: Tip! When you visit your Google Analytics Settings page at google.com, the UA-xxxxxx-x string next to your site domain is the UserAccount.

    • API key—Insert the API key that you saw in Step 12.
      —Image— 

      

18. Within the web.config's <analyticsSettings> tags is a suppressBeacon element that lets you track or suppress the tracking of users on your website. Many site administrators do not want to track user behavior in Traffic Analytics reports, as it corrupts the data. (This setting does not apply to Business Analytics.) See Also: Analyzing Websites. Here are the possible values for this element.
    • None—Track all users, including authenticated membership and Ektron users.
    • Members—Track unauthenticated and logged-in Ektron users only. Do not track membership users.
    • Authors—Track unauthenticated and logged-in membership users only. Do not track Ektron users.
    • All—Track unauthenticated users only. Do not track membership and Ektron users.
19. Within the web.config's <appSettings> tags is an ek_AutoInsertBeaconScript element that either tracks or suppresses tracking activity on your website. Change its value to true.
20. Save web.config.

    IMPORTANT: No server control is needed to track Web Analytics. After you enable Web Analytics in the web.config file, the following JavaScript is automatically added to each PageBuilder page and any site page that contains an Ektron server control.

    <%@ Control Language="C#" 
      AutoEventWireup="true" 
      CodeFile="googletrackingcode.ascx.cs" 
      Inherits="Analytics_Template_GoogleTrackingCode" 
      EnableTheming="false" EnableViewState="false" %> 
    <!-- Start Google Code --> 
    <script type="text/javascript"> 
      var _gaq = _gaq || []; 
      _gaq.push(['_setAccount','<asp:literal id="GoogleUserAccount" runat="server"/>']); 
      _gaq.push(['_trackPageview']); 
      <asp:literal runat="server" id="variables"/> 
        (function() 
          { var ga = document.createElement('script'); 
          ga.type = 'text/javascript'; 
          ga.async = true; 
          ga.src = ('https:' == document.location.protocol ? 'https://ssl' :
             'http://www') + '.google-analytics.com/ga.js';
          s.parentNode.insertBefore(ga, s);
            var s = document.getElementsByTagName('script')[0]; 
          }
        )(); 
    /* Start Track Event binding Code */ 
    //
    // extracted from 
    // http://runtingsproper.blogspot.com/
    //   2009/12/how-to-automatically-track-events-with.html 
    //
    // un-comment the below if you would like google analytics to track your pdf   
      // download links on the website. 
    //$(document).ready(function () { 
    // TrackEventsForClicks(); 
    //}); 
    // 
    //function TrackEventsForClicks() 
    //{ 
    // TrackEventByFileExtension(".pdf");
    // 
    // add your file extension here 
    //} 
    // 
    //function TrackEventByFileExtension(FileExtension) 
    // {
    // $("a[href$='" + FileExtension + "']").click(function() 
    //{
    // var fileURL = $(this).attr("href"); 
    // _gaq.push(['_trackPageview', fileURL]); 
    // }); 
    //} 
    /* End Track Event Binding Code */ 
    </script> <!-- End Google Code -->

Tracking a Single Page

As an alternative to tracking your entire site, you can track individual .aspx pages. To do that, follow these steps on every page you wish to track.

Prerequisite

You completed all steps in Setting up Google Analytics.

1. Open the siteroot/web.config file.
2. Find the ek_AutoInsertBeaconScript tag.
3. Set its value to false.
4. Save web.config.

   NOTE: The previous steps disable the tracking code on your website.

5. Open Visual Studio.
6. Open the .aspx page to which you want to apply the tracking code.
7. In the Solution Explorer tree, navigate to Workarea/Analytics/template/googletrackingcode.ascx.
8. Drag and drop that user control onto the page.
9. Assign EktronAnalyticsTrackingCode as the ID of the control.

Tracking Clicks by File Type

To track the number of times that files on your site (for example, PDFs) are accessed, follow these steps.

Prerequisite

You completed all steps in Setting up Google Analytics.

1. Open the siteroot/web.config file.
2. Find the ek_AutoInsertBeaconScript tag.
3. Set its value to false.
4. Save web.config.

   NOTE: The previous steps disable the tracking code on your website.

5. Open Visual Studio.
6. Open the .aspx page to which you want to apply the tracking code.
7. In the Solution Explorer tree, navigate to Workarea/Analytics/template/googletrackingcode.ascx.
8. Uncomment the code shown below.
   

   /* Start Track Event binding Code */
   //
   // extracted from 
   // http://runtingsproper.blogspot.com
   //   /2009/12/how-to-automatically-track-events-with.html
   //
   // un-comment the below if you would like google analytics to track your pdf 
   //   download links on the website.
   //$(document).ready(function () { 
   // TrackEventsForClicks();
   //});
   //
   //function TrackEventsForClicks()
   //{	
   // add your file extension here
   // TrackEventByFileExtension(".pdf");
   //
   //}
   //
   //function TrackEventByFileExtension(FileExtension)
   //{
   // $("a[href$='" + FileExtension + "']").click(function() {
   // var fileURL = $(this).attr("href");
   // _gaq.push(['_trackPageview', fileURL]);
   // });
   //}
   /* End Track Event Binding Code */

The JavaScript tracks the opening of PDF files on your website. To add file types, copy TrackEventByFileExtension(".pdf");, paste it below, and update the file type. See example below.

xfunction TrackEventsForClicks()
  {
    TrackEventByFileExtension(".pdf");
    TrackEventByFileExtension(".png");

Google Site Reports

You can access site-level Google Analytics reports from within the Workarea by selecting Reports > Traffic Analytics > Google.

NOTE: The following text was adapted from Google Analytics Help Center. Check that site for additional details on the reports.

Google sites reports show direct traffic on left side, top content on the right.

Search reports show terms used by site visitors to find content on your site. Note that this data is not retrieved from Google Analytics. Instead, it is retrieved from Ektron’s site search.

The following sections describe Google’s site-level reports.

Viewing Google Segments

Google Analytics has an Advance Segments tool that lets you "slice and dice" your Analytics data with great precision. Advanced segments let you choose what types of visits you want to be considered when generating the data for a report." (source: About Advanced Segments)

Google segments allow marketers using analytics reports to drill down to specific classes, or segments, of site visitors, such as

• Users
• Sessions and visitors
• Members and authors

This section explains how to select and view segments within Ektron.

NOTE: While you can view custom segments within Ektron, you must create them within Google Analytics.

1. Browse to a view of Analytics data. See Also:
2. Click Segment ().
   —Image—

   

   

   

   

3. The Segments screen appears. Select up to 4 segments to display.
4. The screen refreshes and graphs each segment in a different color. In the following example, new visitors are graphed in blue and returning visitors are orange. Also, the screen breaks down data by each segment.
   —Image—

   

1. Create a Webtrends Account and create a tracking script.
   1. Set up a Webtrends account: Webtrends Developer Network.
   2. Webtrends sends you an account name, username, and password.
   3. Log into Webtrends using this URL: Webtrends Developer Network Login.
   4. Use your Webtrends account name, username, and password.
   5. From that page, follow this menu path: Administration> Application Settings > Data Sources.
   6. Click New. A Data Source Wizard screen appears.
      • Enter a name for the data you will retrieve.
      • Select your server's time zone.
      • Click Next.
      • A summary of the information you entered appears along with a Webtrends data collection server ID (DCSID) value.
      • Click Save. The Data Sources screen reappears with your new data source.
   7. Copy your Data Source ID number (DCSID), indicated in the following figure. You will use this number in the next step.
      —Image—

      

2. Build the Tracking Files. In this step, you tell Webtrends the type of data you want to track. Webtrends then generates files that track that data.
   1. Open Webtrends' Tag Builder page: Webtrends Tag Builder
   2. From the Data Sources screen, you can click Build Tag (Tracking Code).
   3. Complete this page, which prompts you to identify which data Webtrends should track.
   4. Into the page's Webtrends data collection server ID (DCSID)field, paste the number you copied in Step 1g above. For help completing the Tag Builder page, click the information button in the top right corner.
      —Image—

      

   5. Click the Build Tag button. Webtrends generates files you will use to track usage statistics. The Summary and Confirmation screen appears.
   6. Click the Download tag button.
      —Image—

      

   7. Save the .zip file to your computer.
3. Copy Webtrends Tracking Files to Ektron. You must have permission to edit files on theEktron Web server. In this step, you replace the Webtrends.html file in your Workarea folder with the one you downloaded, and you replace the <div> tag in your Workarea's Webtrends.ascx file with the one in the downloaded file of the same name.
   1. Extract the .zip file you downloaded.
   2. Open the folder that contains the extracted files.
   3. Copy Webtrends.js.
   4. Paste it into the site root\Workarea\Analytics\template folder. This action replaces a file of the same name.
   5. In the folder that contains the extracted files, open Webtrends.html.
   6. Copy the following <div> tag.

      <div><img alt="DCSIMG" id="DCSIMG" width="1" height="1"
      src="http://statse.webtrendslive.com/dcs5jd1eg000000g8d40tx1df_5k2p
      /njs.gif?dcsuri=/nojavascript&amp;
      WT.js.No&amp;WT.tv9.3.0&amp;WT.dcssip=www.documentation.ektron.com"/>
      </div>

   7. In the site root\Workarea\Analytics\template folder, open Webtrends.ascx.
   8. Replace the <div> tag with the one you copied.
4. Update Ektron's web.config file. You must have permission to edit files on your Ektron Web server.
   1. Obtain a value for your web.config file's ProfileFileName property by going to https://ws.Webtrends.com/v2/ReportService/profiles/?format=xml. (Authentication required.)
      • In the User name field, enter your account name\username that you obtained.
      • In the Password field, enter your password. A screen displays your Webtrends profile as follows.

        <?xml version="1.0" encoding="utf-8" ?> —
        <list> —
          <ProfileDefinition> 
            <string name="ID">ABCD1234</string> 
            <string name="name">MyAnalyticsAccountName</string> 
            <decimal name="AccountID">234567</decimal> 
            <decimal name="TimeZoneID">-500</decimal> 
          </ProfileDefinition> 
        </list>

        You will use the string name value (highlighted in red), ProfileFileName property.

   2. Open your siteroot/web.config file
   3. Find the tag beginning with <add name="Webtrends".
   4. Replace the Webtrends tag's properties.
      • Name—The name displayed on the report. If you have several accounts, you can use names like these.
        • Webtrends—developer.ektron.com
        • Webtrends—document.ektron.com

        However, the value of this field for one analytics provider must match the value of the <AnalyticsDataProvider defaultProvider> tag.

      • Type—Do not change.
      • Username, Password—
        1. Go to C:\Program Files\Ektron\CMS400vxx\
Utilities\EncryptEmailPassword.exe.
        2. Encrypt the Webtrends username and password you obtained.
        3. Enter the encrypted values into these properties.
      • ProfileFileName—Enter the string name value you obtained.
      • SiteURL—Enter the URL visitors use to access your site. For example, www.example.com.
      • UserAccount—Enter the account name you obtained.
      • Endpoint—The default value is https://ws.Webtrends.com/v2/ReportService/. You only need to update this value if you are not using the default Data Collection Server on the Tag Builder page.
      • Cache Interval—Use to cache the Analytics provider's data. Enter a number in seconds. The maximum 86400. Caching improves the performance of the traffic report page.
      • AnalyticsTrackingCodePath—Do not change.

Displaying Webtrends Site Reports

You can access Webtrends analytics reports within the Workarea by selecting Reports > Traffic Analytics > Webtrends.

Refer to the following WebTrends manual for information about specific reports: Webtrends Administration User Guide > Chapter 32 : Webtrends Analytics Report Library

Display Options

Webtrends reports provide the following display options.

1. Log onto site and generate tracking code.
   1. Contact Adobe and set up an account to use Adobe Analytics.
   2. Use the information Adobe provides (URL, username, password, and so on) to log in to Adobe Online Marketing Suite.
      —Image—

      

   3. Click Admin > Admin Console > Code Manager.
      —Image—

      

   4. In the Select the type of code to generate drop-down, choose Javascript.
   5. In the Select a Report Suite that collects data for your website drop-down, choose a report suite you selected when setting up your Adobe Analytics account.
   6. In the Match the Character-Encoding of your website drop-down, choose UTF-8.
   7. In the Choose your Currency for Tracking Conversion drop-down, choose your currency.
   8. In the How many periods are in your domain name? drop-down, enter the appropriate number. The screen shows an example.
   9. If your site uses SSL, check the box next to Use https:// instead of http://?. See Also: Installing Ektron
   10. Click Generate Code.
2. Copy the tracking code to sitecatalyst.ascx.
   1. The Code Manager screen displays code to track analytics on your Ektron site. Copy the code under the Page Code tab.
      —Image—

      

   2. Open the following file:site root\Workarea\Analytics\template\sitecatalyst.ascx.
   3. Delete all text below the following line.

      <%@ Control Language="C#" 
        AutoEventWireup="true" 
        CodeFile="sitecatalyst.ascx.cs" 
        Inherits="Analytics_Template_Adobe Analytics" 
        EnableTheming="false" EnableViewState="false" %>

   4. Paste the code you copied in Step 1 into sitecatalyst.ascx, below the line shown above.
   5. Save sitecatalyst.ascx.
3. Copy the s_code.js file to Workarea folder.
   1. Use the Code Manager screen's Code Archive Name field to assign a name to the files you created in the previous step.
      —Image—

      

   2. Use the Code Archive Description field to assign a more detailed description to the files you created in Analyzing Websites.
   3. Click Save. Code Manager compresses the Page Code and Core JavaScript files into a .zip file, and displays them under Saved Code.
   4. Click Download next to the saved .zip file. You are prompted to download the .zip file to your computer.
   5. Click OK.
   6. Open the downloaded .zip file.
   7. Extract the s_code.js file to site root\workarea\analytics\template. You may be prompted to confirm that you are overwriting a file of that name already in the folder.
4. Update Ektron's web.config file.

   NOTE: Your Adobe Analytics Web Services Username and Shared Secret. To obtain, log in to Adobe Online Marketing Suite and click Admin > Admin Console > Company > Company Home > Web Services.

   —Image—

   

   1. Open your siteroot/web.config file.
   2. Find the tag beginning with <add name="SiteCatalyst".
   3. Replace the Adobe Analytics tag's properties.
      • Name—Do not change.
      • Type—Do not change.
      • Username, Secret—
        1. Go to C:\Program Files\Ektron\CMS400vxx\Utilities
\EncryptEmailPassword.exe.
        2. Encrypt the Adobe Analytics Web Services Username and Shared Secret you obtained.
        3. Enter the encrypted values into these properties.
      • CompanyName—Enter the company name obtained from Adobe when your account was created.
      • ReportSuiteID—Enter the ReportSuiteID obtained from Adobe when your account was created.
      • SiteURL—Enter the site URL. For example, www.example.com.
      • Endpoint—Enter your account's endpoint. You obtain one when you set up your Adobe Analytics account. An endpoint looks like this: https://api-sbx1.omniture.com/admin/1.2/rest/.
      • CacheInterval—You can use this field to cache the Analytics provider's data. Enter a number in seconds. The maximum 86400 (24 hours). Caching improves the performance of the traffic report page.
      • AnalyticsTrackingCodePath—Do not change.

Adobe Analytics Reports

You can access site-level Adobe Analytics reports from within the Workarea by selecting Reports > Traffic Analytics > Adobe Analytics.

NOTE: The descriptions were adapted from Adobe Analytics Analytics Help Center (Adobe Marketing Cloud Sandbox Sign In). Check that site for additional details on the reports.