Versions Compared

Key

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

...

  1. Launch CardioLog.
  2. In the Welcome dialog, select the desired interface language and date format, and your SharePoint version, then click Next.


    Configuration Wizard Step 1

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

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

    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).
    Manually add the JavaScript tracking code.
    Note: Please select one option only to configure the Tracking Agent.

    Deploy 'CardioLog Analytics' SharePoint Feature

    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.  

    In the Usage Tracking dialog, select "Yes, install and activate CardioLog Analytics SharePoint Feature" and enter the SharePoint application server machine name:
    Step 2 - Usage Tracking
  4. Click Next
  5. Wait while the wizard installs the cardiologtrackingagentfeature.wsp solution file, deploys the solution throughout all web front ends, and activates the CardioLog Analytics feature. If this step fails, please refer to the following article - how to install the CardioLog Analytics feature manually.
    To view the deployed solution in SharePoint 2013, go to Central Administration > System Settings > Manage farm solutions
    SharePoint 2013 - Solution Management
    In the Solution Properties, click cardiologtrackingagentfeature.wsp and verify that the solution was successfully deployed to all web front ends.
    SharePoint 2013 - Solution Properties
    To view the deployed solution in SharePoint 2010, go to Central Administration > System Settings > Manage farm solutions
    SharePoint 2010 - Solution Management
    In the Solution Properties, click cardiologtrackingagentfeature.wsp and verify that the solution was successfully deployed to all web front ends.
    SharePoint 2010 - Solution Properties
    To view the deployed solution in MOSS 2007, go to Central Administration > Operations > Solution Management
    MOSS 2007 - Solution Management
    In the Solution Properties, click cardiologtrackingagentfeature.wsp and verify that the solution was successfully deployed to all web front ends.
    MOSS 2007 - Solution Properties
    Activate/Deactivate Data Collection
    Upon installation of the CardioLog Analytics feature, it is automatically activated and data is being collected.
    Warning: The deactivation operation will stop data collection
    To deactivate the CardioLog Analytics feature in SharePoint 2013, go to Central Administration > System Settings > Manage farm features
    SharePoint 2013 - Manage farm features
    To deactivate the CardioLog Analytics feature in SharePoint 2010, go to Central Administration > System Settings > Manage farm features
    SharePoint 2010 - Manage farm features
    To deactivate the CardioLog Analytics feature in MOSS 2007, go to Central Administration > Operations > Manage farm features
    MOSS 2007 - Manage farm features
    Note: The CardioLog Analytics SharePoint Feature will work only for master pages which contain the following control in the head section:
    <SharePoint:DelegateControl runat="server" ControlId="AdditionalPageHead" AllowMultipleControls="true"/>
    This control is included in the master pages for all SharePoint templates, except the MOSS 2007 Publishing Site master page. 
    Add this control to all MOSS 2007 Publishing Site master pages, right before the closing </HEAD> tag. Alternatively, you can also use a top master file which is included in all of the Publishing Sites master pages, in order to perform a single update.

     

    Automatically add the JavaScript tracking code

    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
    Note: If your SharePoint website runs on SSL, you will have to create a certificate for the CardioLog website and configure it to enable SSL. Alternatively, you can install the CardioLog Analytics SharePoint Feature
    See how to configure the Tracking Agent with SSL for more details.
     
  6. Click Next
  7. (3) Manually add a JavaScript tracking codeIf you wish to add the tracking code yourself - select "No, I will add the tracking code myself" and copy the JavaScript tracking code to a common page component of your choice - such as master pages, page toolbars, Web Parts, footer, etc. If you choose a common JavaScript (.js) file, verify you have removed the opening and closing <script> tags!
  8.  

  9. Testing the tracking Agent:
    1. Open a new browser window and click Next Step.
    2. Delete your browser temporary internet files and click Next Step.
    3. Browse 3 pages on your SharePoint website and click Next Step.
    4. Click Test Event Collection.

     
     
    Step 2 - Usage Tracking 

     

    In the SharePoint Adaptor dialog, enter the SQL server instance name and the SharePoint configuration database name for your farm. Specify the authentication method used to connect to the database, then click Next.
    Note: Please confirm that the CardioLog service account has read permissions (data reader) for all SharePoint configuration and content databases.

    Step 3 - SharePoint Adaptor
     
     

    In the SharePoint Adaptor dialog, select the SharePoint website/s you wish to report on. Enter the name of one of your SharePoint WFE's, then click Next.
    Note: Loading your SharePoint tree structure may take several minutes (depending on the number of items in the selected web sites).

    Step 3 - SharePoint Adaptor

     

    In the SharePoint Adaptor dialog, expand the web site tree and verify that it shows the desired SharePoint web application, then click Next.
    Step 3 - SharePoint Adaptor
    In the Usage Data Processing dialog, click Next.
    Step 4 - Usage Data Processing
    In the Finish dialog, click Finish. Click Show Raw Usage Data to view the usage events collected thus far. The data will be available in reports in the next hour.
    Step 5 - Finish 
  10. Assign roles for users.
  11. Configure email alerts for scheduled services and event collection thresholds that will be sent to the administrator.
  12. Configure the Active Directory Updates service in order to segment authenticated visitors by their user names and their groups.

...

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: 
<!--  Support claims based authentication  -->   

...

[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:

...

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):

  1. profile_1_includedWebApps - this is a star separated list of web applications (virtual servers) to include in the tree.
  2. 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)
  3. 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.
  4. 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:

  1. profile_1_configDB - this is the connection string for the SharePoint configuration database.
  2. 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