SharePoint Tree Adaptor

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:

1. Confirm that the CardioLog service account has db_datareader SQL permissions for the SharePoint portal content database (required for SharePoint 2013 only).
2. In the Administration pane, click System Configuration, and then select SharePoint Tree Adaptor.
3. Click on your SharePoint farm.
4. In the Web Sites section, select a web application zone.
    
   System Configuration - SharePoint Tree Adapter - Select Zone
    
5.  Select the web application/s you want to monitor.
    
    System Configuration - SharePoint Tree Adapter - Select web applications
   
   
6. Select the site collection/s you want to monitor.
   
   System Configuration - SharePoint Tree Adapter - Select site collections 
    
7. Restart the CardioLog Scheduling Service by selecting Administration in the navigation pane, and then selecting CardioLog Scheduling Service. Click Restart Service in the upper right hand corner.
8. The tree structure will be refreshed the next day, after the Portal Tree Updates job is executed. The updated tree structure will be available in the Analysis Center and Object Explorer.
9. If you are using the CardioLog Analytics tracking feature, or if you have configured the CardioLogAgent web application on your SharePoint WFEs, open the new web application in IIS Manager and verify that the CardioLogAgent folder under the "_layouts" directory is configured as a web application (if not, right click on it and select "Convert to Application").
10. 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

1. Add the db_datareader SQL permissions to the CardioLog service account for the SharePoint portal configuration and content databases, and grant read access to the SharePoint TEMPLATE folder (required for SharePoint 2013 only).
2. In the Administration section of the navigation pane, click System Configuration, and then select SharePoint Tree Adaptor.
3. Click Add Farm, and then select your SharePoint version.
4. In the SharePoint Tree Adaptor dialog, fill out the following fields:
   • 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 from SharePoint user profiles. Add the db_datareader SQL permissions to the CardioLog service account for the SharePoint profile database.
   • Authentication - Database authentication type. Click Set to choose between Windows Integrated and SQL Server Authentication.
   • SharePoint TEMPLATE Directory - This is the full path for the SharePoint 'TEMPLATE' directory. Ex: "\\<sharepoint WFE server name>\C$\Program Files\Common Files\Microsoft Shared\Web Server Extensions\XX\TEMPLATE\" (Where XX = 12 for MOSS 2007; 14 for SharePoint 2010; 15 for SharePoint 2013). 
   • Advanced Settings - Select the additional import and transfer preferences you would like to include.
     
     
   
   System Configuration - SharePoint Tree Adaptor
   
   
5. In the Web Sites section, select a web application zone.
    
   System Configuration - SharePoint Tree Adapter - Select Zone
    
6.  Select the web application/s you want to monitor.
    
    System Configuration - SharePoint Tree Adapter - Select web applications
   
   
7. Select the site collection/s you want to monitor.
   
   System Configuration - SharePoint Tree Adapter - Select site collections 
   
   
8. Restart the CardioLog Scheduling Service. The tree structure will be refreshed the next day, after the Portal Tree Updates job is executed. The updated tree structure will be available in Analysis Center and Object Explorer.

Configuring the CardioLog Analytics Tracking Code

1. In the Administration section of the navigation pane, click System Configuration, and then select SharePoint Tree Adaptor.
2. Click on the SharePoint farm > Additional Actions > Click on Install Tracking Feature.
   
    
   System Configuration - SharePoint Tree Adapter - Install Tracking Feature
    
3. Select Farm > Click on Install.
   
   
   Install Tracking Feature
   
   
4. This action will automatically deploy the 'CardioLog Analytics' farm level solution and copy the tracking agent code to all of your SharePoint Web Front End (WFE) servers.
   Note: The following permissions and roles are required for the CardioLog user account to update the 'CardioLog Analytics' solution: SharePoint farm administrator; local administrator on the SharePoint application server and WFEs; "db_owner" on the SharePoint config database.
   
   
5. Temporary downtime of SharePoint is required while deploying the 'CardioLog Analytics' solution. In case you would like to install it manually follow this guide: 'CardioLog Analytics' SharePoint Feature Manual Installation Procedure.
6. In order to track modern sites, click on the SharePoint farm > Additional Actions > Click on Download Sppkg.
   
   
   
   System Configuration - SharePoint Tree Adapter -Download Sppkg
   
   
7. Right click the sppkg-deployment-archive.zip file, select Properties > General and click on "Unblock" before unzipping it.
8. Open the sites.json file and verify that all of the site collections you would like to track are included.
9. Execute the RUN_SCRIPT.ps1 script in PowerShell. Make sure the you have the following prerequisites before executing the PowerShell script:
   
   • You must have PowerShell version 5.1 or higher.
   • The credentials of the SharePoint farm administrator.
   • Make sure that the account that you are using is not a system account.
     
     
     
     
10. The script will automatically deploy the modern sites integration app on the App catalog and on all selected site collections and their sub-sites.

 

SharePoint Online

Configuring Multiple Site Collections

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

1. In the Administration pane, click System Configuration, and then select SharePoint Tree Adaptor.
2. Click on your SharePoint Online tenant and select the site collection/s you want to monitor.
3. Restart the CardioLog Scheduling Service. The tree structure will be refreshed the next day, after the Portal Tree Updates job execution.
4. Configure event collection - deploy the CardioLog Analytics SharePoint solution on your site collection/s or 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:

1. In the Administration pane, click System Configuration, and then select SharePoint Tree Adaptor.
2. Click Add Farm, and then select SharePoint Online.
3. In the SharePoint Tree Adaptor dialog, fill out the following fields:
   
   
   System Configuration - SharePoint Online Tree Adaptor
   
   
   1. Name - This is the title of the SharePoint Online tenant folder which will be displayed in the CardioLog tree structure in the Analysis Center. Example: "SharePoint Online"
   2. SharePoint Admin Center URL (https://) - Enter the SharePoint Admin Center URL in a secured format (https://).
   3. Authentication - The selected account should have a Global Administrator role in Office 365 Admin Center.
      1. Microsoft Live ID (Office 365)
      2. OAuth (recommended) - in order to securely connect to the SharePoint Online API, register and configure a new SharePoint Online App to obtain the required authentication details (client ID and client secret).
         
         
   
   
4. Click the magnifying glass icon.
5. Select the site collection/s you want to monitor and click Save.
6. Restart the CardioLog Scheduling Service. The tree structure will be refreshed the next day, after the Portal Tree Updates job execution.
7. Configure event collection by either deploying the CardioLog Analytics SharePoint solution on all of your site collections or insert the JavaScript code manually on your master page.

Create a SharePoint Online App

Register New App

1. Login to SharePoint with the Global Administrator account.
2. Navigate to https://<Admin Center>/_layouts/15/AppRegNew.aspx (e.g. https://intlock-admin.sharepoint.com/_layouts/15/AppRegNew.aspx).
    (If you do not have permissions to access this URL, use the root site collection URL instead: https://<Root Site Collection>/_layouts/15/AppRegNew.aspx)
3. Click Generate to automatically create Client Id and Client Secret and copy these values.
4. Enter a Title for app. For example, "CardioLogApp".
5. Fill in App Domain and Redirect URI which should use the same app domain that is entered. For example, www.intlock.com and https://www.intlock.com/.
   
6. Click Create
   
   
7. If the app was created successfully, the following message will appear: "The app identifier has been successfully created".

Grant Permissions to App

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

2. Paste client ID generated earlier into App Id field. Click Lookup. The existing values for Title, App Domain and Redirect URL should appear.

3. Enter the following XML into the App's Permission Request XML field to specify required permissions. Then click 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>

   

4. You will be prompted to approve permissions for the app. Click Trust It.
   
   
5. You can check the App registration details by navigating to: https://<Admin Center>/_layouts/15/AppPrincipals.aspx

6. You 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

Renew App Expired Client Secret ID

1. Execute the following PowerShell script with the SharePoint Online Global Administrator account in order to retrieve your App client ID. Edit the "CardioLogApp" name. You can check what is your App name by navigating to: https://<Admin Center>/_layouts/15/AppPrincipals.aspx
2. Open the C:\appsec.txt output file and copy the Client ID value:
   
   
   
   

3. Execute the following PowerShell script with the SharePoint Online Global Administrator account. Edit the "Client ID" and use the value copied from step 2.

4. Execute the following PowerShell script with the SharePoint Online Global Administrator account, in the same PowerShell window, in order to generate a new client secret ID.

5. Copy the client secret ID and update it in CardioLog configuration settings:

   1. In the Administration section of the Navigation pane, click System Configuration, and then select SharePoint Tree Adaptor.
   2. Click on your SharePoint Online tenant.
   3. Click Set next to the Authentication settings and select the OAuth option
   4. Enter the Client ID (copied from step 2) and renewed client secret ID (generated in step 4) and click Save.

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:

1. In the Administration section of the Navigation pane, click System Configuration, and then select SharePoint Tree Adaptor.
2. Click on your SharePoint Online tenant.
3. Click on Download next to Additional Actions to download the tracking code deployment package WSP-Tracking-Install-Script.zip. 
   Note: The deployment package 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 and their sub-sites.
   
   
   SharePoint Online Adaptor - Download Tracking Code Deployment Package
    
4. Right click the downloaded package zip file, select Properties > General and click on "Unblock" before unzipping it.

5. Open the tracking.txt file and edit the <cardiologserverdnsname> (CardioLog application server/tracking server public DNS name, without the https:// protocol prefix). Verify that it is accessible over the public internet.

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

   
   

6. Run the Run_Script.ps1 script in PowerShell. Make sure the you have the following prerequisites before executing the PowerShell script:
   
   • You must have PowerShell version 5.1 or higher with the MS Online module installed. 
   • The 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 options
     In case a specific site collection does not inherit these settings from SharePoint Central Administration, you can execute the following commands in SharePoint Online Management Shell (replace the placeholders for [company] and [site collection url]):

     $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()