Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Using the System Configuration settings, you can easily configure usage tracking and reporting, manage users and groups, and how your site connects to other environments.

 

Image Removed

...

...

Contents

...

In addition to being able to access the Configuration Wizard any time from the System Configuration window, the Configuration Wizard will be displayed automatically upon activating CardioLog. This wizard will help you configure the SharePoint Tracking Agent, which is a tool designed to monitor visitor behavior in SharePoint, and the SharePoint Adapter, which provides the structure of your SharePoint portal.

Login to the CardioLog server with your CardioLog service account and verify that it has the required permissions before running the wizard.

Please review this entire section in order to determine the tracking mechanism that should be deployed. If you choose to deploy 'CardioLog Analytics' SharePoint feature, the wizard should run with SharePoint administrator privileges. 

...

This step can be performed in one of the following ways:

(1) Automatically add the JavaScript tracking code to all SharePoint pages served by the WFE by deploying the CardioLog tracking code through a SharePoint solution.

(2) Automatically add the JavaScript tracking code to all SharePoint pages served by the WFE by adding the tracking code to init.js in SharePoint 2010/13, and core.js in SharePoint 2007 (recommended for test environments only).

...

CardioLog provides a SharePoint solution (cardiologtrackingagentfeature.wsp)  for installing the JavaScript tracking code on all farm pages. This SharePoint solution includes a farm-scoped feature named CardioLog Analytics, which can be activated or deactivated through SharePoint's Central Administration.
Note: SharePoint farm administrator and local administrator roles on the SharePoint application server and WFEs are required.  

...

 

...

Notes: This step should be done for each WFE. The CardioLog service account must have write permissions to the SharePoint template directory: 
[SharePoint 2013 Server]\%PROGRAMFILES%\Common Files\Microsoft Shared\web server extensions\15\TEMPLATE
[SharePoint 2010 Server]\%PROGRAMFILES%\Common Files\Microsoft Shared\web server extensions\14\TEMPLATE
[SharePoint 2007 Server]\%PROGRAMFILES%\Common Files\Microsoft Shared\web server extensions\12\TEMPLATE 

In the Usage Tracking dialog, select "Yes, add the tracking code to my SharePoint INIT.JS files" and enter the SharePoint WFE server names, to allow CardioLog to automatically add the tracking code to all SharePoint pages served by the all the WFEs in your farm (the tracking code is added to init.js in SharePoint 2010 and SharePoint 2013, and core.js in SharePoint 2007).

 

...

 

...

 
 
Step 2 - Usage Tracking 

 

...

Step 3 - SharePoint Adaptor
 
 

...

Step 3 - SharePoint Adaptor

 

...

By default, the CardioLog Tracking Agent tracks document usage for documents which are accessed through the browser. This is achieved by tracking browser clicks in document libraries (which are not displayed in Explorer view).
In order to track document access from non-browser sources - such as Windows Explorer or Office, you need to install the CardioLog HttpModule for SharePoint.

...

<configuration>
  <system.web>
    <httpModules>
      <add name="CardioLogHttpModule" type="CardioLog.HttpModules.EventsModule,CardioLogHttpModule, Version=1.19.154.6, Culture=neutral, PublicKeyToken=56b51e29d93ab3fb" />

...

<configuration>
  <system.webServer>
    <modules>
      <add name="CardioLogHttpModule" type="CardioLog.HttpModules.EventsModule,CardioLogHttpModule, Version=1.19.154.6, Culture=neutral, PublicKeyToken=56b51e29d93ab3fb" />

...

    <add key="CardioLog.Events.DocExtensions" value=".doc*.docx*.ppt*.pptx*.pps*.ppsx*.txt*.pdf*.xlr*.xls*.xlsx*.log*.msg*.odt*.rtf*.csv*"/>
    <add key="CardioLog.Events.ExcludeUserAgents" value="Microsoft Office Existence Discovery*"/>
    <add key="CardioLog.API.EventsServiceUrl" value="http://<CardioLog server>:<port>/CardioLogAPI/Events.asmx"/>
    <add key="CardioLog.Events.LogFile" value="C:\CardioLogHttpModule.log"/>
    <add key="CardioLog.Events.LogLevel" value="None"/><!--None,Error,Message-->
    <add key="CardioLog.Events.SharePointVersion" value="2013"/>
Optional keys:    

...

[Installation directory] - by default, the CardioLogAgent folder is located in the CardioLog Installation folder. If the "CardioLog Analytics" SharePoint feature is installed, the CardioLogAgent folder is located on all SharePoint WFEs under the SharePoint website "_layouts" folder.

...

 In order to monitor an additional web application in your existing farm, please do the following:

  1. Add the required SQL permissions to the CardioLog service account - db_datareader for the SharePoint portal content database.
  2. In the Administration pane, click System Configuration, and then select SharePoint Tree Adaptor.
  3. Click on your SharePoint farm and select the web application/s you want to monitor.
  4. Click Save
  5. In versions lower than 2.0.8.0, add the portal root URL to the "includedWebApps" key in the <CardioLog Installation Folder>\SP20XXTree\web.config file (XX - 07 for MOSS 2007, 10 for SharePoint 2010, 13 for SharePoint 2013).
  6. Restart the CardioLog Scheduling Service. The tree structure will be refreshed the next day.
  7. If you are using the CardioLog Analytics tracking feature or if you have configured the CardioLogAgent web application on the SharePoint WFEs, open the new web application in IIS Manager and verify that the CardioLogAgent folder under the "_layouts" directory is configured as a web application (if not, right click on it and select "Convert to Application").
  8. Verify data collection from the new web application.

...

In order to monitor multiple SharePoint farms per adaptor, please do the following:

...

System Configuration - SharePoint Tree Adaptor

...

In <CardioLog Installation Folder>\SP20XXTree\web.config (XX - 07 for MOSS 2007, 10 for SharePoint 2010, 13 for SharePoint 2013), add the following keys to the <appSettings> section with the "profile_1_ "prefix (additional farms are considered additional profiles):

  • profile_1_includedWebApps - this is a star separated list of web applications (virtual servers) to include in the tree.
  • profile_1_SharePointTemplatePath - this is the full path for the SharePoint 'TEMPLATE' directory (XX - 12 for MOSS 2007, 14 for SharePoint 2010, 15 for SharePoint 2013)
  • profile_1_FarmFolderName - Optional. This is the title of the farm folder which will be displayed in the CardioLog tree structure in the Analysis Center.
  • profile_1_outputFilePath - this is the full path of the CardioLog installation folder 'Logs' directory which will store the tree structure output file (XX - 07 for MOSS 2007, 10 for SharePoint 2010, 13 for SharePoint 2013).

<appSettings>

<add key="profile_1_includedWebApps" value="http:// <sharepoint server name>:<port>*" />
<add key="profile_1_SharePointTemplatePath" value="\\<sharepoint server name>\C$\Program Files\Common Files\Microsoft Shared\Web Server Extensions\XX\TEMPLATE\" /> 

<add key="profile_1_FarmFolderName" value="SharePoint 2010" />

<add key="profile_1_outputFilePath" value="<CardioLog installation folder>\CardioLogScheduleServices\Logs\SP20XXTree_1.xml" />

</appSettings>

Add the following keys to the <connectionStrings> section:

  • profile_1_configDB - this is the connection string for the SharePoint configuration database.
  • profile_1_contentDB - this is a place holder for creating connection strings to the SharePoint content databases. Note: Leave "Initial Catalog={0};Data Source={1} " as it is.

<connectionStrings>

<add name="profile_1_configDB" connectionString="Integrated Security=SSPI;Persist Security Info=False;Initial Catalog=<sharepoint config database name>;Data Source=<database server name>" />
<add name="profile_1_contentDB" connectionString="Integrated Security=SSPI;Persist Security Info=False;Initial Catalog={0};Data Source={1}" />

</connectionStrings>

Go to Administration > CardioLog Scheduling Service > Portal Tree Updates and add the new profile to the Portal Tree Updates web services list:

http://<CardioLogServer>:<port>/SP20XXTree/default.aspx?profile=1&output=file&logFilePath=[CardioLog Installation Folder]\CardioLogScheduleServices\Logs\SP20XXTree_1.xml (XX - 07 for MOSS 2007, 10 for SharePoint 2010, 13 for SharePoint 2013)

Restart the CardioLog Scheduling Service. The tree structure will be refreshed the next day.

Note: In order to add multiple farms, use the profile_2_, profile_3_ etc... prefix.

...

To improve performance, CardioLog caches the results for each reporting query in accordance with the specific report filters used. In the Cache Configuration page, you can define the amount of time queries are cached,  and clear the entire reporting cache.

  1. In the Administration pane, click System Configuration, and then select Reporting Data.
  2. In the Reporting Data Cache Configuration box, check Enable Reporting Data Caching to enable report caching.
  3. Fill out a value for the Cache life time in days field.
  4. Click Save
  5. Click Clear Cache if you want to clear the entire reporting cache.

...

 System Configuration > Reporting Data

Image Added

System Configuration Main Window