1.

2. 3. 4.

5.

6.

SharePoint Tree AdaptorSharePoint On-Premise

Configuring Multiple Web Applications and Site CollectionsConfiguring Multiple Farms

Configuring the SharePoint Farm Tree StructureConfiguring the CardioLog Analytics Tracking Code

Importing Document Versioning Information for your SharePoint Lists and LibrariesImporting Social Information for your SharePoint FarmImporting Metadata Information for your SharePoint List Items, Documents or SitesImporting the SharePoint Tree Structure via the SharePoint API

SharePoint OnlineConfiguring Multiple Site CollectionsConfiguring Multiple SharePoint Online Tenants

Create a SharePoint Online AppDeploying the CardioLog Tracking Code on Multiple Site CollectionsImporting Document Versioning Information for your SharePoint Lists and Libraries

SharePoint On-Premise

Configuring Multiple Web Applications and Site Collections

 In order to monitor an additional web application/site collection in your existing farm, please do the following:

Confirm that the CardioLog service account has   SQL permissions for the SharePoint portal content database (required fordb_datareaderSharePoint 2013 only).In the   pane, click  , and then select  .Administration System Configuration SharePoint Tree AdaptorClick on your SharePoint farm.In the  section, select a web application zone.Web Sites 

 System Configuration - SharePoint Tree Adapter - Select Zone  Select the web application/s you want to monitor.

  System Configuration - SharePoint Tree Adapter - Select web applications

Select the site collection/s you want to monitor.

6.

7.

8.

9.

10.

1.

2. 3. 4.

 System Configuration - SharePoint Tree Adapter - Select site collections Restart the CardioLog Scheduling Service by selecting   Administration in the navigation pane, and then selecting CardioLogScheduling Service. Click  in the upper right hand cornerRestart Service .The tree structure will be refreshed the next day, after the job is executed. The updated tree structure willPortal Tree Updatesbe available in the Analysis Center and Object Explorer.If you are using the  , or if you have configured the CardioLogAgent web application on yourCardioLog Analytics tracking featureSharePoint WFEs, open the new web application in IIS Manager and verify that the CardioLogAgent folder under the " " directory_layoutsis configured as a web application (if not, right click on it and select "Convert to Application").Verify data collection from the new web application.

Configuring Multiple Farms

In order to monitor multiple SharePoint farms using the SharePoint Tree Adaptor, please follow these steps:

Configuring the SharePoint Farm Tree Structure

Add the  SQL permissions to the CardioLog service account for the SharePoint portal configuration and content databases,db_datareaderand grant read access to the SharePoint TEMPLATE folder (required for SharePoint 2013 only).In the   section of the navigation pane, click  , and then select  .Administration System Configuration SharePoint Tree AdaptorClick   and then select your SharePoint version.Add Farm,In the   dialog, fill out the following fields:SharePoint Tree Adaptor

Name - This is the title of the farm folder which will be displayed in the CardioLog tree structure in the Analysis Center. Ex:"SharePoint 2013"Database Server - The SharePoint database instance name.SharePoint Configuration Database Name - The SharePoint configuration database name. Ex: "SharePoint_Config"SharePoint Profile Database Server,  SharePoint Profile Database Name - Optional. Used when configuring user categories

. Add the   SQL permissions to the CardioLog service account for the SharePointfrom SharePoint user profiles db_datareaderprofile database.Authentication - Database authentication type. Click Set to choose between Windows Integrated and SQL ServerAuthentication.SharePoint TEMPLATE Directory - This is the full path for the SharePoint 'TEMPLATE' directory. Ex: "\\<sharepoint WFE

(Where  =  forserver name>\C$\Program Files\Common Files\Microsoft Shared\Web Server Extensions\ \TEMPLATE\" XX XX 12MOSS 2007;  for SharePoint 2010;  for SharePoint 2013). 14 15 Advanced Settings - Select the additional import and transfer preferences you would like to include.

4.

5.

6.

7.

System Configuration - SharePoint Tree Adaptor

In the  section, select a web application zone.Web Sites 

 System Configuration - SharePoint Tree Adapter - Select Zone  Select the web application/s you want to monitor.

  System Configuration - SharePoint Tree Adapter - Select web applications

Select the site collection/s you want to monitor.

7.

8.

1. 2.

3.

4.

 System Configuration - SharePoint Tree Adapter - Select site collections

Restart the . The tree structure will be refreshed the next day, after the   job is CardioLog Scheduling Service Portal Tree Updatesexecuted. The updated tree structure will be available in Analysis Center and Object Explorer.

Configuring the CardioLog Analytics Tracking Code

In the   section of the navigation pane, click  , and then select  .Administration System Configuration SharePoint Tree AdaptorClick on the SharePoint farm > Additional Actions > Click on  .Install Tracking Feature

 System Configuration - SharePoint Tree Adapter - Install Tracking Feature Select > Click on . Farm   Install

Install Tracking Feature

This action will automatically deploy the 'CardioLog Analytics' farm level solution and copy the tracking agent code to all of yourSharePoint Web Front End (WFE) servers.

: The following permissions and roles are required for the CardioLog user account to update the 'CardioLog Analytics' solution:NoteSharePoint farm administrator; local administrator on the SharePoint application server and WFEs; "db_owner" on the SharePoint config

4.

5.

6.

7. 8. 9.

10.

1.

2.

database.

Temporary downtime of SharePoint is required while deploying the 'CardioLog Analytics' solution. In case you would like to installit manually follow this guide:  .'CardioLog Analytics' SharePoint Feature Manual Installation ProcedureIn order to track , click on the SharePoint farm > Additional Actions > Click on  .modern sites Download Sppkg

System Configuration - SharePoint Tree Adapter -Download Sppkg

Right click the   file, select Properties > General and click on " " before unzipping it.sppkg-deployment-archive.zip UnblockOpen the   file and verify that all of the site collections you would like to track are includedsites.json .Execute the RUN_SCRIPT.ps1 script in PowerShell. Make sure the you have the following prerequisites before executing the PowerShellscript:

You must have   or higher.PowerShell version 5.1The credentials of the SharePoint farm administrator.Make sure that the account that you are using is   a system account.not

The script will automatically deploy the modern sites integration app on the App catalog and on all selected site collections and theirsub-sites.

 

Importing Document Versioning Information for your SharePoint Lists and Libraries

In order to take full advantage of document modification reports, turn on versioning for your SharePoint lists and libraries. Versioning is themethod by which successive iterations of a given document are numbered and saved.

To collect document versioning information from SharePoint: 

Go to Administration in the navigation pane, click System Configuration, and then select SharePoint Tree Adaptor.

2. 3.

4. 5. 6. 7. 8.

1. 2. 3.

Click on the SharePoint farm you would like to collect document versioning information from.Check  in the Advanced Settings section."Import document versioning information for your SharePoint lists and libraries" 

 SharePoint Tree Adaptor - Import Document Versioning Click   at the bottom of the page to confirm.SaveIn the   navigation pane, click  .Administration CardioLog Scheduling ServiceClick  .Portal Tree UpdatesSet the Service Schedule and then click  .OKClick   to activate any changes.Restart Service

Importing Social Information for your SharePoint Farm

SharePoint offers a variety of out-of-the box social features such as content likes, rating and ranking, sharing content, following content, andmore.

To import social information from SharePoint 2013 or above, and perform detailed analysis of the site's social activity:

Go to   in the navigation pane, click  , and then select  .Administration System Configuration SharePoint Tree AdaptorClick on the SharePoint farm you would like to collect social information from.Check  in the Advanced Settings section." " Import social information for your SharePoint farm

3.

4. 5. 6. 7. 8. 9.

1. 2. 3.

SharePoint Tree Adaptor - Import Social Information

Click   at the bottom of the page to confirm.SaveIn the   navigation pane, click  .Administration CardioLog Scheduling ServiceClick . Social UpdatesSet the Service Schedule and then click  .OKClick   to activate any changes.Restart ServiceSocial reports will be available in the Report Center.

Importing Metadata Information for your SharePoint List Items, Documents or Sites

To import metadata fields for your SharePoint list items and documents or property bag entries for SharePoint sites, and perform detailed analysisbased on this information:

Go to   in the navigation pane, click  , and then select  .Administration System Configuration SharePoint Tree AdaptorClick on the SharePoint farm you would like to import metadata information from.Check  in the Advanced Settings section." " Import metadata information for your SharePoint list items, documents or sites

3.

4.

SharePoint Tree Adaptor - Import Metadata Information

Click to select the metadata fields you would like to import.Manage Metadata 

4.

5. 6. 7.

SharePoint Tree Adaptor - Manage Metadata Click to add SharePoint metadata fields.AddSelect the metadata field type - attribute or (term set) attribute.Open Text Managed MetadataFor Open Text attributes click , type the field name and click .Add attribute Save

7.

8.

9.

 Add SharePoint Metadata field - Open Text Attribute For Managed Metadata attributes, select the fields you would like to import and click .Save

 Add SharePoint Metadata field - Managed Metadata (term set) Attribute Select the SharePoint content type for each metadata field.

9.

10. 11. 12. 13. 14. 15.

SharePoint Tree Adaptor - Manage Metadata - Select Content Type Click   at the bottom of the page to confirm.SaveIn the   navigation pane, click  .Administration CardioLog Scheduling ServiceClick . Portal Tree UpdatesSet the Service Schedule and then click  .OKClick   to activate any changes.Restart ServiceMetadata filters will be available in the Report Center.

Importing the SharePoint Tree Structure via the SharePoint API

1.

2. 3. 4.

CardioLog Analytics System Architecture When the SharePoint Tree Structure is loaded via the SharePoint API 

In order to import the SharePoint farm tree structure using the SharePoint REST API (available for SharePoint 2013, 2016 and 2019), pleasefollow these steps:

Make sure you can access the SharePoint Admin Center URL and all SharePoint web applications URLs (/_api/) from the CardioLogapplication server over HTTP/HTTPS.In the   section of the navigation pane, click  , and then select  .Administration System Configuration SharePoint Tree AdaptorClick  , and then select your SharePoint version.Add FarmIn the   dialog, fill out the following fields:SharePoint Tree Adaptor

Name - Enter the title of the farm folder that you would like to display in the Object Explorer and in the Analysis Center. Ex:"SharePoint 2016"Advanced Settings - For SharePoint 2013, check " " in the AdvancedImport the SharePoint tree structure via the SharePoint APISettings section.Authentication - Choose between Windows Integrated or Windows authentication. The selected account should be theSharePoint farm admin service account (make sure the farm admin account has full access rights to the selected webapplications in SharePoint Central Administration > Manage Web Application > User Policy).SharePoint Admin Center URL - Enter the SharePoint Admin Center URL. Ex: http://intlock.com:2016/"

(Optional)Web Sites List in CSV format   - Use this when a SharePoint Admin Center URL is not available. Enter the file pathfor the CSV that contains the list of web applications you would like to monitor.

4.

5. 6.

a. b. c.

d. e.

f.

System Configuration - SharePoint Tree Adaptor - SharePoint 2013

System Configuration - SharePoint Tree Adaptor - SharePoint 2016 In the  section, select a web application zone and click the magnifying glass icon.Web Sites If the list of web applications is not available via SharePoint Central Administration, please follow these steps:

Go to [CardioLog Installation Folder]\Setup Files\Copy the powershell script file < > to your SharePoint Central Administration server.webs.ps1Login to your SharePoint Central Administration server with the SharePoint farm administrator account and run Windows Power

 as an administrator.ShellExecute the webs.ps1 script. The script will generate a list of web applications in CSV format in C:\webapps.csv

6.

f. g.

7. 8. 9.

10. 11.

1. 2. 3.

4.

1. 2. 3.

In the   dialog, enter the CSV file path in SharePoint Tree Adaptor Web sites list in CSV format. Select a web application zone and click the magnifying glass icon.

Select all of the web applications you would like to monitor, then click  .SaveIn the   navigation pane, click  .Administration CardioLog Scheduling ServiceClick . Portal Tree UpdatesSet the Service Schedule and then click  .OKClick   to activate any changes.Restart Service

SharePoint Online

Configuring Multiple Site Collections

In order to monitor additional site collections in your existing SharePoint Online environment, follow these steps: 

In the   pane, click  , and then select  .Administration System Configuration SharePoint Tree AdaptorClick on your   tenant and select the site collection/s you want to monitor.SharePoint OnlineRestart the The tree structure will be refreshed the next day, after the   job CardioLog Scheduling Service.  Portal Tree Updatesexecution.Configure event collection - deploy the   on your site collection/s or CardioLog Analytics SharePoint solution insert the code manually (to

.your master page)

Configuring Multiple SharePoint Online Tenants

In order to monitor a new SharePoint Online environments, follow these steps:

In the   pane, click  , and then select  .Administration System Configuration SharePoint Tree AdaptorClick   and then select  .Add Farm, SharePoint OnlineIn the   dialog, fill out the following fields:SharePoint Tree Adaptor

System Configuration - SharePoint Online Tree Adaptor

3.

a.

b. c.

i. ii.

4. 5. 6.

7.

1. 2.

3. 4. 5.

6.

Name - This is the title of the SharePoint Online tenant folder which will be displayed in the CardioLog tree structure in theAnalysis Center. Example: "SharePoint Online"SharePoint Admin Center URL (https://) - Enter the SharePoint Admin Center URL in a secured format (https://).Authentication - The selected account should have a Global Administrator role in Office 365 Admin Center.

Microsoft Live ID (Office 365)OAuth (recommended) - in order to securely connect to the SharePoint Online API, register and configure a new

client ID and client secret). to obtain the required authentication details (SharePoint Online App

Click the magnifying glass icon.Select the site collection/s you want to monitor and click  .SaveRestart the The tree structure will be refreshed the next day, after the   job CardioLog Scheduling Service.  Portal Tree Updatesexecution.Configure event collection by either deploying the   on all of your site collections or CardioLog Analytics SharePoint solution insert the

on your master page.JavaScript code manually

Create a SharePoint Online App

Register New App

Login to SharePoint with the Global Administrator account.Navigate to   (e.g. https://<Admin Center>/_layouts/15/AppRegNew.aspx https://intlock-admin.sharepoint.com/_layouts/15/Ap

).pRegNew.aspx

 (If you do not have permissions to access this URL, use the root site collection URL instead: https://<Root SiteCollection>/_layouts/15/AppRegNew.aspx)Click   to automatically create   and  and copy these values.Generate Client Id Client SecretEnter a   for app. For example, "CardioLogApp".TitleFill in   and   which should use the same app domain that is entered. For example,   and App Domain Redirect URI www.intlock.com https://www.intlock.com/.Click Create

6.

7.

1.

2.

3.

If the app was created successfully, the following message will appear: ."The app identifier has been successfully created"

Grant Permissions to App

Navigate to   (e.g. https://<Admin Center>/_layouts/15/AppInv.aspx https://intlock-admin.sharepoint.com/_layouts/15/AppInv.).aspx

Paste client ID generated earlier into   field. Click  . The existing values for  ,   and   shouldApp Id Lookup Title App Domain Redirect URLappear.Enter the following XML into the field to specify required permissions. Then click  .App's Permission Request XML Create 

<AppPermissionRequests AllowAppOnlyPolicy="true">  <AppPermissionRequest Scope=" http://sharepoint/content/tenant" Right="Manage"/>  <AppPermissionRequest Scope=" http://sharepoint/content/sitecollection" Right="Manage"/>  <AppPermissionRequest Scope=" http://sharepoint/content/sitecollection/web" Right="Manage"/>  <AppPermissionRequest Scope=" http://sharepoint/social/tenant" Right="Manage"/></AppPermissionRequests>

3.

4.

5. 6.

1. 2.

3.

You will be prompted to approve permissions for the app. Click Trust It.

You can check the App registration details by navigating to: https://<Admin Center>/_layouts/15/AppPrincipals.aspxYou can test the App credentials by executing the following powershell commands to retrieve the list of all available site collections.

$ Connect-PnPOnline https://<your-tenant>-admin.sharepoint.com -AppId <your-app-id> -AppSecret <your-app-secret>$ Get-PnPTenantSite

Deploying the CardioLog Tracking Code on Multiple Site Collections

In order to deploy the tracking code on multiple site collections in your SharePoint Online environment, follow these steps:

In the   section of the Navigation pane, click  , and then select  .Administration System Configuration SharePoint Tree AdaptorClick on your   tenant.SharePoint Online

3.

4. 5.

6.

Click on   next to to download the tracking code deployment package  Download Additional Actions  WSP-Tracking-Install-Script.zip.: The deployment package Note includes a PowerShell script that deploys the tracking agent wsp solution and JavaScript tracking code

on all selected site collections, as well as the modern sites integration app on the App catalog and on all selected site collections andtheir sub-sites.

SharePoint Online Adaptor - Download Tracking Code Deployment Package Right click the downloaded package zip file, select Properties > General and click on " " before unzipping it.UnblockOpen the   file and edit the <cardiologserverdnsname> (CardioLog application server/tracking server public DNS name, tracking.txt witho

 the https:// protocol prefix). Verify that it is   over the public ut accessible internet.

Run the Run_Script.ps1 script in PowerShell. Make sure the you have the following prerequisites before executing the PowerShellscript:

You must have   or higher with the   installed. PowerShell version 5.1 MS Online moduleThe credentials of the SharePoint Online global administrator.If you are using multi-factor authentication (MFA), make sure you have an app password for Office 365.Make sure custom scripts are turned on (changes in this setting take up to 24 hours to apply):Office 365 Admin > Admin Centers > SharePoint Admin Center > Settings > Custom Script > Select Allow in both optionsIn case a specific site collection does not inherit these settings from SharePoint Central Administration, you can execute thefollowing commands in SharePoint Online Management Shell ( ):replace the placeholders for [company] and [site collection url]

sourceDomain: '<cardiologserverdnsname>/CardioLogAgent/js/modern', eventListenerDomain: '<cardiologserverdnsname/CardioLogAgent',modules: [ ], 'survey-and-message-bar'statisticsPath: '<cardiologserverdnsname>/CardioLogAgent/ReportDispatcher.aspx'

6.

1. 2. 3.

Importing Document Versioning Information for your SharePoint Lists and Libraries

In order to take full advantage of document modification reports, turn on for your SharePoint lists and libraries. versioning Versioning numbers andsaves .successive iterations of a given document to monitor changes in the document over time

To collect document versioning information from SharePoint Online: 

Go to Administration in the navigation pane, click System Configuration, and then select SharePoint Tree Adaptor.Click on the SharePoint Online site you would like to collect document versioning information from.Enable  next to  ."Import document versioning information for your SharePoint lists and libraries" Advanced Settings

 

$url = "https://[company]- "admin.sharepoint.com$User = Read-Host -Prompt "Enter username for $url"$Password = Read-Host -Prompt 'Enter password' -AsSecureString$credentials = New-Object Microsoft.SharePoint.Client.SharePointOnlineCredentials($User,$Password)$adminContext = New-Object Microsoft.SharePoint.Client.ClientContext($url)$adminContext.Credentials = $credentials$tenant = New-Object Microsoft.Online.SharePoint.TenantAdministration.Tenant($adminContext)$adminContext.Load($tenant)$adminContext.ExecuteQuery()$props = $tenant.GetSitePropertiesByUrl("[site collection url]", $false)$adminContext.Load($props)$adminContext.ExecuteQuery()$DenyAddAndCustomizePagesStatusEnum =[Microsoft.Online.SharePoint.TenantAdministration.DenyAddAndCustomizePagesStatus]$props.DenyAddAndCustomizePages = $DenyAddAndCustomizePagesStatusEnum::Disabled$props.Update()$adminContext.ExecuteQuery()

3.

4. 5. 6. 7. 8.

SharePoint Online Adaptor - Import Document Versioning Click   at the bottom of the page to confirm.SaveIn the   navigation pane, click  .Administration CardioLog Scheduling ServiceClick  .Portal Tree UpdatesSet the Service Schedule and then click  .OKClick   to activate any changes.Restart Service