Augmented Analytics Configuration Guide

Once you have installed the Augmented Analytics add-in for SharePoint from the Microsoft Office Store, you will then be redirected to a configuration screen.

The configuration contains a few simple steps that walk you through setting up Augmented Analytics.

Augmented Analytics Configuration Screen

Step 1: Choose Sites to Integrate with

In order to display the Augmented Analytics reports in SharePoint, select which site collections you would like to integrate with and display the reports on.

The Augmented Analytics reports are only available on sites once the tracking code is deployed for them in the "Add the Augmented Analytics Tracking Code to your Sites" step.

With this section expanded, you should see all of your available SharePoint Online site collections.
Select all the sites you would like to integrate with.
You can also search for site collections by typing in their name in the search bar.
Select the button next to each site you would like to integrate with.
Click Save to confirm your selection.

You can go back and add more sites or remove sites from your selection at any point.

Please note that the integration process for large site collections may take a few hours up to a few weeks, depending on the environment size.

Augmented Analytics Configuration Screen: Step 1

Step 2: Choose Permission Level to Grant Access By

In order to grant access to the Augmented Analytics reports, select which permission level you would like to grant access to.

Users with this permission level will see the Augmented Analytics reports on the selected site collections.

Augmented Analytics Configuration Screen: Step 2

Step 3: Add the Augmented Analytics Tracking Code to Your Sites

This step allows you to add the JavaScript tracking code to each of your sites.

You can add the tracking code to specific sites or deploy it on all selected site collections automatically.

Augmented Analytics Configuration Screen: Step 3

Deploying the Tracking Code to all Selected Site Collections Automatically

Download the automatic deployment Package from the "Add the Augmented Analytics Tracking Code to your Sites" step in the Configuration page.
The package includes a PowerShell script that deploys the tracking agent wsp solution, modern sites integration app and the Java Script tracking code on all selected site collections.
Right click the downloaded package zip file, select Properties > General and click on "Unblock" before unzipping it.
Execute the Run_Script.ps1 script in Windows PowerShell (do not use Windows PowerShell ISE version). Make sure to close all browser windows on your machine before executing the script.
Note: You must have the MS Online module installed and the credentials of the SharePoint Online global administrator.

Add the Tracking Code to a Site Collection Manually

Browse to your SharePoint Online site Solution Gallery. The gallery should be found at this address by replacing the website root URL with yours: https://company.sharepoint.com/_catalogs/solutions/forms/allitems.aspx
From your Solution Gallery, click Upload Solution > Choose File. Then select CardioLog Analytics Integration.wsp and click Activate.
If you are presented with a request for access, go to the Admin Center, found under the Office 365 Admin menu.
1. From the SharePoint Admin Center select Settings.
2. Choose Custom Script.
3. Select Allow for both options. (Allow users to run custom script on personal sites & Allow users to run custom script on self-service created sites)
4. Allow custom scripts on all site collections you wish to monitor:
  1. The preference change may take up to 24 hours. In order to force the change to take place immediately, you may download and run the SharePoint Online Management Shell.
  2. Follow Microsoft's instructions for connecting it to your SharePoint Online tenant,
  3. For classic sites, execute the following shell command:
    
    Set-SPOsite <SiteURL> -DenyAddAndCustomizePages 0
  4. For modern sites, execute the following shell command (edit the #parameters section):
    
    #Parameters
    $TenantAdminURL= "https://company-admin.sharepoint.com"
    $SiteURL= "https://company.sharepoint.com/sites/site"
    
    #Connect to Tenant Admin
    Connect-PnPOnline $TenantAdminURL -UseWebLogin
    
    #Get the Tenant Site Object
    $Site = Get-PnPTenantSite -Url $SiteURL
    
    #Enable Custom Scripting by turning OFF Deny Flag
    $Site.DenyAddAndCustomizePages = "Disabled"
    $Site.Update()
    $Site.Context.ExecuteQuery()
Once the solution is installed, return to the Augmented Analytics configuration screen and copy the JavaScript tracking code.
Browse to CardioLog Analytics Integration solution configuration page. The page should be found at this address by replacing the website root URL with yours: https://company.sharepoint.com/CardioLogAnalytics/Configuration.2.0.8.0.aspx
Paste the tracking code copied from the "Add the Augmented Analytics Tracking Code to your Sites" step and click OK.
To enable support for tracking SharePoint Online modern sites and pages, install the Tracking Agent App:
1. Download the automatic deployment package from the "Add the Augmented Analytics Tracking Code to your Sites" step in the configuration page.
2. Upload CardioLogTrackingAgentAddin.sppkg app to the SharePoint Admin apps > App Catalog > Apps for SharePoint > New:
3. Click Deploy (do NOT select "Make this Solution available to all sites in the organization")
4. Go to the tracked Site Collection > Site Contents > New App
5. Click on Apps from your organization and click CardioLog Tracking Agent (it will be installed automatically)

Note: The tracking code contains links to the Events Listener web application in Azure.

Content

Space Tools