"CardioLog Analytics" SharePoint Feature Manual Installation Procedure

Overview

CardioLog Analytics 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.

The deployment of the SharePoint solution is done automatically through step 2 of the CardioLog Analytics configuration wizard. The wizard should run with SharePoint farm administrator privileges.

In this article you can find details on the manual installation procedure.

• Deployment Procedure
• Activate/Deactivate Data Collection
• Uninstall Procedure

Deployment Procedure

Installing the CardioLog Tracking Agent web application

1. Copy the [CardioLog Installation Folder]\CardioLogAgent folder to your SharePoint WFE server to C:\Program Files\Common Files\Microsoft Shared\web server extensions\1X\TEMPLATE\LAYOUTS\ folder (1X - 12 for MOSS 2007, 14 for SharePoint 2010/SharePoint 2013)
2. Edit the value of the following key in the CardioLogAgent\web.config file, located in the <appSettings> section -
   
   <add key="CardioLogAgentRoot" value="/_layouts"/> 
3. Open IIS Manager, right click the CardioLogAgent directory located under the SharePoint website _layouts folder and select "Convert to Application". The selected application pool should be the SharePoint website application pool.
   
4. Repeat step 3 for each SharePoint website you wish to monitor.
5. Repeat steps 1 - 4 for each SharePoint WFE server.

Installing the “CardioLog Analytics” SharePoint Feature

1. Go to [CardioLog Installation Folder]\CardioLog\Configuration\AgentFeature\
2. Copy the solution file "cardiologtrackingagentfeature.wsp" to your SharePoint application server to C:\Program Files\Common Files\Microsoft Shared\web server extensions\1X\BIN folder (1X - 12 for MOSS 2007, 14 for SharePoint 2010, 15 for SharePoint 2013)
3. Execute the following commands from command prompt in order to add and deploy the solution to the SharePoint farm (edit the directory path):

Activate/Deactivate Data Collection

Upon installing 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, besides 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.

Uninstall Procedure

Removing the "CardioLog Analytics" Feature using SharePoint Central Administration

1. Deactivate the CardioLog Analytics feature as detailed here.
2. Retract the solution and remove it.
   
   For SharePoint 2013 only - Go to Central Administration > System Settings > Manage farm solutions > Click cardiologtrackingagentfeature.wsp > Click Retract Solution.
   
   
   
   
   For SharePoint 2010 only - Go to Central Administration > System Settings > Manage farm solutions > Click cardiologtrackingagentfeature.wsp > Click Retract Solution.
   
   
   For MOSS 2007 only - Go to Central Administration > Operations > Solution Management > Click cardiologtrackingagentfeature.wsp > Click Retract Solution.
   
   
   Once the solution status shows "Not Deployed", click Remove Solution in order to completely remove the solution.
   
   
3. Open IIS Manager > Remove the CardioLogAgent web application located under the _layouts folder
4. Open the LAYOUTS folder and remove the CardioLogAgent folder
5. Repeat steps 3 and 4 for each SharePoint website
6. Repeat steps 3 - 5 for each SharePoint WFE server

Delete your browser cache and verify that when you browse the SharePoint website that you no longer see the CardioLog tracking agent popup when clicking on Ctrl+F12 on the keyboard or when clicking the Agent Console link (follow the instructions in http://cardiologserver:port/CardioLog/Configuration/AgentConsoleBookmarklet.aspx to add the agent console link to your browser).

Removing the "CardioLog Analytics" Feature using Command Line

Execute the following commands from command prompt in order to deactivate the feature, retract and remove the solution from your SharePoint farm (edit the directory path: 1X - 12 for MOSS 2007, 14 for SharePoint 2010, 15 for SharePoint 2013):