CardioLog Usage Reports SharePoint Feature

The "CardioLog Usage Reports" SharePoint Feature enables you to view usage reports from within your SharePoint website, via the "Site Actions" menu. For more information see View CardioLog Analytics Reports from SharePoint's Site Actions Menu.

 
Submit queries directly from website pages with the CardioLog Usage Reports SharePoint feature 

In order to install the CardioLog Usage Reports SharePoint Feature, which is only available for for use with SharePoint On Premise, perform the following steps:

1. Go to [CardioLog Installation Folder]\CardioLog\Setup Files\wsp. The following solutions are available:

   Name	Solution Scope	Feature Scope	Auto Activated
   CardioLog-Usage-Reports-SharePoint-Feature-Global-FarmActivation	Farm	Farm	Yes
   CardioLog-Usage-Reports-SharePoint-Feature-Global-SiteCollectionActivation	Farm	Site Collection	No
   CardioLog-Usage-Reports-SharePoint-Feature-SpecificWebAppDeployment	Web Application	Site Collection	No
   CardioLog-Usage-Reports-SharePoint-Feature-FullControlOnly	Farm	Site Collection	No

   Note: The "Site Statistics" option will be added to the Site Actions menu and visible to everyone with read permissions on your SharePoint site. When installing the CardioLog-Usage-Reports-SharePoint-Feature-FullControlOnly solution, the "Site Statistics" option will be visible only to users with full Admin permissions on your SharePoint site.
   
   

2. Drop the desired "CardioLogUsageReportsSolution.wsp" solution file on your SharePoint application server in C:\Program Files\Common Files\Microsoft Shared\web server extensions\1X\BIN\ (Where 1X is 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 BIN directory path: C:\Program Files\Common Files\Microsoft Shared\web server extensions\1X\BIN (Where 1X is 12 for MOSS 2007; 14 for SharePoint 2010; 15 for SharePoint 2013):
   
   

   cd c:\program files\common files\microsoft shared\web server extensions\1X\BIN

   stsadm -o addsolution -filename CardioLogUsageReportsSolution.wsp         

   stsadm -o deploysolution -name CardioLogUsageReportsSolution.wsp -immediate
   
   
4. If you have selected a solution that does not auto activate, you can activate the CardioLog Usage Reports feature for the site collection of your choice by navigating in SharePoint to Site Actions > Site Settings > Site Collection Administration > Site collection features > Activate the "CardioLog Usage Reports" feature.
5. Add one of the following JavaScript functions to the file containing the CardioLog agent tracking code on all of your SharePoint WFEs (Web Front Ends) (Enter your CardioLog server name and port where relevant).
   

   By default, the Java Script tracking code is embedded within a common Java Script file on your SharePoint WFEs according to the version you have installed: 
   
   For MOSS 2007 only:
   C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\12\TEMPLATE\LAYOUTS\1033\core.js
   
   For SharePoint 2010 only:
   C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\LAYOUTS\1033\init.js
   
   For SharePoint 2013 only:
   C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\15\TEMPLATE\LAYOUTS\init.js
   
   For MOSS 2007 with "CardioLog Analytics" SharePoint Feature only:
   C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\12\TEMPLATE\LAYOUTS\CardioLogAgent\CardioLogAgent.js
   
   For SharePoint 2010 with "CardioLog Analytics" SharePoint Feature only:
   C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\LAYOUTS\CardioLogAgent\CardioLogAgent.js
   
   For SharePoint 2013 with "CardioLog Analytics" SharePoint Feature only:
   C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\LAYOUTS\CardioLogAgent\CardioLogAgent.js
    

   The code is located at the end of the file, between the comments //Intlock tracking code start and //Intlock tracking code end Add the following function to the code using your CardioLog server name and port number:

   //Intlock Site Statistics Feature  - START

   function getStatistics()

   { window.open("http://CardioLogServer:port/CardioLog/reports.aspx?url="+encodeURIComponent(document.location.href)); }

   //Intlock Site Statistics Feature  - END
   
   

6. Perform IISRESET using the IIS Manager on all SharePoint WFEs.
    

To mirror SharePoint permissions and allow access to the generated report URL based on the logged-on user permissions in SharePoint (available using the CardioLog Analytics SharePoint Feature only), perform the following steps:

1. Use the following JavaScript function instead of the code described above:
   
   

   //Intlock Site Statistics Feature  - START

   function getStatistics() {

         window.open("/_layouts/CardioLogAgent/ReportDispatcher.aspx?url=" + encodeURIComponent(document.location.href));

   }

   //Intlock Site Statistics Feature  - END
   
   

2. Edit the following file on all SharePoint WFEs: C:\Program Files\Common Files\Microsoft Shared\web server extensions\1X\TEMPLATE\LAYOUTS\CardioLogAgent\web.config (Where 1X is 12 for MOSS 2007; 14 for SharePoint 2010; 15 for SharePoint 2013)
   
   • <add key="EnableSpSecurity" value="true" /> Mandatory - Edit the value to be either true or false. To enable SharePoint permissions inheritance value should be true.
   • <add key="SpSecurityClaimsAuthentication" value="true" /> Optional - Edit the value to be either true or false. When using claims based authentication in SharePoint value should be true.
   • <add key="SpSecurityPermissionLevel" value="Edit" /> - Optional - Edit the value to be a relevant SharePoint permissions level. If none selected, "Full Control" will be used and only users with full control access to the SharePoint site will have access to the report.
     
     Note: The following permission levels are available:
     SharePoint 2007 and SharePoint 2010 - "Full Control," "Design," "Contribute," "Read," "Limited Access"
     SharePoint 2013 - "View Only," "Edit," "Approve," "Manage Hierarchy," "Restricted Read," "Restricted Interfaces for Translation"
   • <add key="SpSecurityCheckWebAppPolicies" value="true" /> - Optional - Edit the value to be either true or false. Enable this only if permissions are given from central admin through policy and not directly from the site.
3. Edit the following file on the CardioLog application server: [CardioLog Installation Folder]\CardioLog\web.config
• <add key="EnableSpSecurity " value="true" /> Mandatory - Edit the value to be either true or false. To enable SharePoint permissions mirroring, the value should be true.

Note: If you would like to uninstall the site statistics feature, please deactivate it first on every site collection.