Versions Compared

Old Version 33

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
maxLevel4

SharePoint On-Premise

Anchor
multiple web applications
multiple web applications
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 and click the magnifying glass icon.
    Image RemovedImage Added 
    System Configuration - SharePoint Tree Adapter - Select Zone
     
  5.  Select the web application/s you want to monitor and click Save.
    Image RemovedImage Added 
     System Configuration - SharePoint Tree Adapter - Select Web Sites
         web applications

  6. Select the site collection/s you want to monitor.
    Image Added
    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.

...

  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 20162013"
    • 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, 16 for SharePoint 2016)). 
    • Advanced Settings - Select the additional import and transfer preferences you would like to include.


    System Configuration - SharePoint Tree Adaptor

  5. In the the Web Sites section, select a web application zone and click the magnifying glass icon.
    Image RemovedImage Added 
    System Configuration - SharePoint Tree Adapter : - Select Zone
    Select all of  
  6.  Select the web applications you would like application/s you want to monitor, then click Save.
    Image Removed
     SharePoint Image Added 
     System Configuration - SharePoint Tree Adapter : - Select Web Sites
    web applications

  7. Select the site collection/s you want to monitor.
    Image Added
    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.

...

  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.


    Image Added
    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.

      Image Added

  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.

 

Anchor
collecting document
collecting document
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 the method by which successive iterations of a given document are numbered and saved.

To collect document versioning information from SharePoint:
 

  1. Go to Administration in the navigation pane, click System Configuration, and then select SharePoint Tree Adaptor.
  2. Click on the SharePoint farm you would like to collect document versioning information from.
  3. Check "Import document versioning information for your SharePoint lists and libraries" in the Advanced Settings section.

     
    SharePoint Tree Adaptor - Import Document Versioning
     
  4. Click Save at the bottom of the page to confirm.
  5. In the Administration navigation pane, click CardioLog Scheduling Service.
  6. Click Portal Tree Updates.
  7. Set the Service Schedule and then click OK.
  8. Click Restart Service to activate any changes.

Anchor
import social
import social
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, and more.

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

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


    SharePoint Tree Adaptor - Import Social Information

  4. Click Save at the bottom of the page to confirm.
  5. In the Administration navigation pane, click CardioLog Scheduling Service.
  6. Click Social Updates.
  7. Set the Service Schedule and then click OK.
  8. Click Restart Service to activate any changes.
  9. Social reports will be available in the Report Center.

Anchor
import metadata
import metadata
Importing Metadata I

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

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


    SharePoint Tree Adaptor - Import Metadata Information

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


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

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

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


    SharePoint Tree Adaptor - Manage Metadata - Select Content Type
     
  10. Click Save at the bottom of the page to confirm.
  11. In the Administration navigation pane, click CardioLog Scheduling Service.
  12. Click Portal Tree Updates.
  13. Set the Service Schedule and then click OK.
  14. Click Restart Service to activate any changes.
  15. Metadata filters will be available in the Report Center.

Anchor
api
api
Importing the SharePoint Tree Structure via the SharePoint API


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 20162019), please follow these steps:

  1. Make sure you can access the SharePoint Admin Center URL and all SharePoint web applications URLs (/_api/) from the CardioLog application server over HTTP/HTTPS.
  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 - 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 "Import the SharePoint tree structure via the SharePoint API" in the Advanced Settings section.
    • Authentication - Choose between Windows Integrated or Windows authentication. The selected account should be the SharePoint farm admin service account (make sure the farm admin account has full access rights in to the selected web applications user policyin SharePoint Central Administration > Manage Web Application > User Policy).
    • SharePoint Admin Center URL - Enter the SharePoint Admin Center URL. Ex: http://intlock.com:2016/"
    • Web Sites List in CSV format (Optional) - Use this when a SharePoint Admin Center URL is not available. Enter the file path for the CSV that contains the list of web applications you would like to monitor.


    System Configuration - SharePoint Tree Adaptor - SharePoint 2013


    System Configuration - SharePoint Tree Adaptor - SharePoint 2016
     
  5. In the Web Sites section, select a web application zone and click the magnifying glass icon.
  6. If the list of web applications is not available via SharePoint Central Administration, please follow these steps:
    1. Go to [CardioLog Installation Folder]\Setup Files\
    2. Copy the power shell powershell script file <webs.ps1> to your SharePoint Central Administration server.
    3. Login to your SharePoint Central Administration server with the SharePoint farm administrator account and run Windows Power Shell as an administrator.
    4. Execute the webs.ps1 script. 
    5. The script will generate a list of web applications in CSV format in C:\webapps.csv
    6. In the SharePoint Tree Adaptor dialog, enter the CSV file path in Web sites list in CSV format. 
    7. Select a web application zone and click the magnifying glass icon.
  7. Select all of the web applications you would like to monitor, then click Save.
  8. In the Administration navigation pane, click CardioLog Scheduling Service.
  9. Click Portal Tree Updates.
  10. Set the Service Schedule and then click OK.
  11. Click Restart Service to activate any changes.

...

Anchor
multiple sp online
multiple sp online
Configuring Multiple SharePoint Online Tenants

In order to monitor additional 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 - Microsoft Live ID (Office 365). The  The selected account should have SharePoint 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).

        Image Added

  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.

Anchor

...

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

...

sp_app
sp_app
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).
    (info) (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

    Image Added
  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>

    Image Added

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

    Image Added
  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
Anchor
renew_app_client_secret
renew_app_client_secret
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

    Code Block
    Connect-MsolService
$applist = Get-MsolServicePrincipal -all  |Where-Object -FilterScript { ($_.DisplayName -like "*CardioLogApp") }
foreach ($appentry in $applist) {
    $principalId = $appentry.AppPrincipalId
    $principalName = $appentry.DisplayName
    Get-MsolServicePrincipalCredential -AppPrincipalId $principalId -ReturnKeyValues $false | ? { $_.Type -eq "Password" } | % { "$principalName;"+"`nClient ID: "+"$principalId;"+"`nClient Secret ID: " + $_.KeyId.ToString() +";" + $_.StartDate.ToString() + ";" + $_.EndDate.ToString() } | out-file -FilePath c:\appsec.txt -append
}
  2. Open the C:\appsec.txt output file and copy the Client ID value:

    Image Added

  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.

    Code Block
    Connect-MsolService
$clientId = "Client ID"
$keys = Get-MsolServicePrincipalCredential -AppPrincipalId $clientId
$keys
Remove-MsolServicePrincipalCredential -KeyIds $keys.KeyId -AppPrincipalId $clientId

  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.

    Code Block
    $bytes = New-Object Byte[] 32
$rand = [System.Security.Cryptography.RandomNumberGenerator]::Create()
$rand.GetBytes($bytes)
$rand.Dispose()
$newClientSecret = [System.Convert]::ToBase64String($bytes)
$dtStart = [System.DateTime]::Now
$dtEnd = $dtStart.AddYears(1)
New-MsolServicePrincipalCredential -AppPrincipalId $clientId -Type Symmetric -Usage Sign -Value $newClientSecret -StartDate $dtStart -EndDate $dtEnd
New-MsolServicePrincipalCredential -AppPrincipalId $clientId -Type Symmetric -Usage Verify -Value $newClientSecret -StartDate $dtStart -EndDate $dtEnd
New-MsolServicePrincipalCredential -AppPrincipalId $clientId -Type Password -Usage Verify -Value $newClientSecret -StartDate $dtStart -EndDate $dtEnd
$newClientSecret

  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.

Anchor
updating multiple
updating multiple
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 website tenant.
  3. Click on Publish Tracking CodeDownload next to Additional Actions.
    Image Removed
    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.

    Image Added
    SharePoint Online Adaptor - Publish Download Tracking Code Deployment Package
     
  4. Add the JavaScript tracking code you had copied previously 
  5. Click Apply in the bottom right-hand corner to save your changes.
    Image Removed 
     Publish Tracking Code Right click the downloaded package zip file, select Properties > General and click on "Unblock" before unzipping it.

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

    Info
    iconfalse

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


  7. 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]):

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

Anchor
document versions online
document versions online
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 numbers and saves successive iterations of a given document to monitor changes in the document over time.

To collect document versioning information from SharePoint Online:
 

...