SharePoint On-Premise

Configuring Multiple Web Applications

 In order to monitor an additional web application 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.
  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.

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

     
     System Configuration - SharePoint Tree Adapter - Select Web Sites
     
  6. 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.
  7. 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.
  8. 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").
  9. 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.
  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 2016"
    • 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 XX12 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 Web Sites section, select a web application zone and click the magnifying glass icon.


    SharePoint Tree Adapter: Select Zone


  6. Select all of the web applications you would like to monitor, then click Save.


     SharePoint Tree Adapter: Select Web Sites


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

 

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.

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

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

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 2019), 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 to the selected web applications in 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 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.

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 additional 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 selected account should have SharePoint Administrator role in Office 365 Admin Center.

  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.

Publishing the CardioLog Tracking Code on Multiple Site Collections

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

  1. Find Usage Tracking Code in System Configuration, under Administration in the navigation pane.
  2. Select SharePoint Online and then copy the tracking code from the Tracking Code box


    Usage Tracking Code

  3. Verify that the all URLs in the tracking code that redirect to your CardioLog application server have the public DNS name and appropriate protocol. The URLs should be accessible over the public internet. Use HTTPS if you are tracking secured SharePoint Online site collections. 
  4. In the Administration section of the Navigation pane, click System Configuration, and then select SharePoint Tree Adaptor.
  5. Click on your SharePoint Online website.
  6. Click on Publish Tracking Code next to Additional Actions.


    SharePoint Online Adaptor - Publish Tracking Code
     
  7. Add the JavaScript tracking code you had copied previously 
  8. Click Apply in the bottom right-hand corner to save your changes.

     
     Publish Tracking Code 


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:
 

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

     
    SharePoint Online 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.



  • No labels