Versions Compared

Old Version 10

changes.mady.by.user Sigalit Hassid

Saved on

compared with

New Version Current

changes.mady.by.user Sigalit Hassid

Saved on

Key

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

Table of Contents

 

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. Image Removed
Submit queries directly from website pages with the CardioLog Usage Reports SharePoint feature 

Access to generated report URLs is based on the logged-on user's permissions in SharePoint (available only when using the CardioLog Analytics SharePoint Feature).


Image Added
SharePoint Site Actions Menu  - Classic Sites

Image Added
SharePoint Site Actions Menu  - Modern Sites

CardioLog Usage Reports for SharePoint On Premise

SharePoint 2007, 2010, 2013, 2016

In order to install the CardioLog Usage Reports SharePoint Feature for use with SharePoint On Premise,2007, 2010, 2013 or 2016, perform the following steps:

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

    NameSolution ScopeFeature ScopePermission LevelAuto Activated
    CardioLog-Usage-Reports-SharePoint-Feature-Global-FarmActivationFarmFarmReadYes
    CardioLog-Usage-Reports-SharePoint-Feature-Global-SiteCollectionActivationFarmSite CollectionReadNo
    CardioLog-Usage-Reports-SharePoint-Feature-SpecificWebAppDeploymentWeb ApplicationSite CollectionReadNo
    CardioLog-Usage-Reports-SharePoint-Feature-FullControlOnlyFarmSite CollectionFull ControlNo
    CardioLog-Usage-Reports-SharePoint-Feature-Global-FarmActivation-ContributeOnlyFarmFarmContributeYes
    CardioLog-Usage-Reports-SharePoint-Feature-Global-SiteCollectionActivation-ContributeOnlyFarmSite CollectionContributeNo

    Note: The "Site Statistics" option will be added to the SharePoint 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 sitethe specified permission level (or higher).

  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, 16 for SharePoint 2016)

  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, 16 for SharePoint 2016):

    Info
    iconfalse

    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:

    Info
    iconfalse

    //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.

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

    Mirroring SharePoint Permissions

    Follow these steps in order to mirror SharePoint permissions, and allow access to generated report URLs based on the logged-on user's permissions in SharePoint. This method is only available when using the CardioLog Analytics SharePoint Feature:

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

    Info
    iconfalse

    //Intlock Site Statistics Feature  - START

    function getStatistics() {

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

    }

    //Intlock Site Statistics Feature  - END

    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 and SharePoint , SharePoint 2013, SharePoint 2016)
  • <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="View Only,Edit,Approve" /> - Optional - Edit the value to be a relevant SharePoint permissions level, in a comma delimited list. 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 and SharePoint 2016 - "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.
     
  • 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.

    SharePoint 2019

    In order to install the CardioLog Usage Reports SharePoint Feature for use with SharePoint 2019 classic and modern sites, perform the following steps:

    1. Go to the Administration section of the navigation pane, click System Configuration, select SharePoint Tree Adaptor and then select your SharePoint 2019 farm.
    2. Click on Download Sppkg button to download the deployment package. The deployment package includes the ActivateSiteStatisticsFeature.ps1  PowerShell script which adds the Site Statistics custom action to the SharePoint Settings menu for all selected site collections and their sub-sites.

      Image Added
      SharePoint Tree Adaptor Settings

    3. Right click the sppkg-deployment-archive.zip file, select Properties > General and click on "Unblock" before unzipping it.

    4. Open the sites.json file and verify that the SiteStatisticsUrl is correct (edit the URL prefix if you are using a dedicate tracking server).

      Info
      iconfalse

      "SiteStatisticsUrl":"/_layouts/CardioLogAgent/ReportDispatcher.aspx?url={SiteUrl}"

    5. Execute the ActivateSiteStatisticsFeature.ps1  script in PowerShell. Make sure the you have the following prerequisites before executing the PowerShell script:
    6. Select the permissions level that will be used. Only users with the selected permissions level to the SharePoint site will have access to the report.
      The following permission levels are available: "View Only", "Limited Access", "Read", "Contribute", "Edit", "Design", "Full Control".

    CardioLog Usage Reports for SharePoint Online

    Classic Sites

    1. In your SharePoint Online site Solution Gallery browse to: https://intlock.sharepoint.com]/_catalogs/solutions/forms/allitems.aspx Edit the base URL to match your site.
      Select
      solution.JPGImage Added 
      'SharePoint Online' Site Solution Gallery
       
    2. Select Upload Solution >  > Choose File >  > and select select [CardioLog Installation Folder]\Setup Files\wsp\CardioLog-Usage-Reports-SharePoint-Feature-Global-SiteCollectionActivation\CardioLogUsageReportsSolution.wsp and then click click Activate.
    3. Navigate to CardioLog Analytics Integration solution configuration page in your browser: [https://intlock.sharepoint.com]/CardioLogAnalytics/Configuration.2.0.8.0.aspx Edit the base URL to match your site.

      configuration.JPGImage Added 
      CardioLog Analytics Integration Solution Configuration Page
       

    4. Edit the tracking code and add the following

      JavaScript function to the end of the code block, after the //Intlock tracking code end comment

      value to the configuration settings and click OK. Edit the CardioLog server public DNS name used in your system, the URL should be accessible over the internet.

       


      Image Added

      Info
      iconfalse

      function getStatistics() {
      window.open("https://cardiologserverdnsname/CardioLog/reports.aspx?url="+encodeURIComponent(document.location.href));
      }

      statisticsPath: 'https://<cardiologserverdnsname>/CardioLogAgent/ReportDispatcher.aspx'

    5. Go to the CardioLog application server, open IIS, expand the CardioLog website and CardioLogAgent web application, switch to Content View, click the ReportDispatcher.aspx page and select Switch to Features View, choose Authentication, enable Windows Authentication and disable Anonymous Authentication.

      Image Added

    Modern Sites

    In order to install the CardioLog Usage Reports SharePoint Feature for use with SharePoint Online classic and modern sites, perform the following steps:

    1. Go to the Administration section of the navigation pane, click System Configuration, select SharePoint Tree Adaptor and then select your SharePoint Online farm.
    2. Click on Download button to download the deployment package. The deployment package includes the ActivateSiteStatisticsFeature.ps1  PowerShell script which adds the Site Statistics custom action to the SharePoint Settings menu for all selected site collections and their sub-sites.

      Image Added
      SharePoint Tree Adaptor Settings

    3. Right click the WSP-Tracking-Install-Script.zip file, select Properties > General and click on "Unblock" before unzipping it.

    4. Open the sites.json file and verify that the SiteStatisticsUrl is correct (edit the <cardiologserverdnsname> - CardioLog application server / tracking server public DNS name).

      Info
      iconfalse

      "SiteStatisticsUrl":"https://<cardiologserverdnsname>/CardioLogAgent/ReportDispatcher.aspx?url={SiteUrl}"

    5. Execute the ActivateSiteStatisticsFeature.ps1  script in PowerShell. Make sure the you have the following prerequisites before executing the PowerShell script:
    6. Select the permissions level that will be used. Only users with the selected permissions level to the SharePoint site will have access to the report.
      The following permission levels are available: "View Only", "Limited Access", "Read", "Contribute", "Edit", "Design", "Full Control".