CardioLog SaaS Configuration Guide

SharePoint Online

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

The configuration contains a few simple steps that walk you through setting up data collection and connecting to Power BI reports.

CardioLog SaaS Configuration Screen

Step 1: Choose Sites To Track

In this step you can select which site collections you would like to see data for. Sites are only tracked once the tracking code is deployed for them in the "Add the CardioLog Tracking Code to your Sites" step.

With this section expanded, you should see all of your available SharePoint Online site collections and select all the sites you would like to monitor using CardioLog Analytics.
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 monitor.
In order to stop monitoring a site, unselect it. Note that this operation will remove the site from usage reports, but you will have to remove the tracking code from it manually.
In order to stop monitoring a site, but keep history data for it in usage reports, click on the folder icon next to it in order to archive it.
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 import process for large site collections may take a few hours up to a few weeks, depending on the environment size.

CardioLog SaaS Configuration Screen: Step 1

Step 2: Choose User Properties To Report On

In this section you can select all user profile properties that you would like to filter and report on. This information will be taken from SharePoint user profiles. If you have created custom profile properties you can also use them.

It is recommended to select the following basic attributes - department, office, country, manager, title, picture URL.

What are SharePoint Profiles?

Using the search bar, enter the name of any property you would like to find and include.
Select the button next to each user property you would like to include in your usage reports.
In case Personal Identifiable Information (PII) Concealment is enabled, click on the eye icon next to each user property you would like to conceal in your usage reports.
Click Save to confirm your selection.

Properties may be added or removed at any time to accommodate your needs.

CardioLog SaaS Configuration Screen: Step 2

CardioLog SaaS Configuration Screen: Step 2 - Choose User Attributes with PII Concealment

Step 3: Choose Content Metadata Fields to Report On

In this section you can select all content metadata fields that you would like to filter and report on. Metadata fields information will be taken from your SharePoint list items and documents.

It is recommended to select metadata fields that are segmented fields, such as managed metadata columns and lookup fields.

Metadata fields may be added or removed at any time to accommodate your needs.

CardioLog SaaS Configuration Screen: Step 3

Step 4: Add The CardioLog Tracking Code To Your Sites

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

Select one of the following options to add the tracking code to specific sites or deploy it on all selected site collections and their subsites automatically.

Note: If you would like to host the tracking code on a private CDN, please fill out the CDN details in the Advanced Settings before you proceed with adding the tracking code using one of the following options.

Install the tracking code automatically using a SharePoint App (recommended)

Select this option to add the tracking code to all selected sites (in "Choose Sites to Track" step) automatically using a SharePoint App.

Note: This is the recommended method for installing the tracking code on all selected site collections, including automatically enabling it for newly created subsites under the selected site collections.

Create a SharePoint App

Login to SharePoint with the Global Administrator account.
Navigate to https://<Admin Center>/_layouts/15/AppRegNew.aspx (e.g. https://company-admin.sharepoint.com/_layouts/15/AppRegNew.aspx).
Create a 'full-trust' app with the following details:
1. Client ID and Secret - click Generate to automatically create a client ID and secret and copy these values.
2. Title - CardioLog Analytics Tracking Deployment
3. App Domain - localhost
4. Redirect URI - https://localhost
Navigate to https://<Admin Center>/_layouts/15/AppInv.aspx (e.g. https://company-admin.sharepoint.com/_layouts/15/AppInv.aspx).
Paste the client ID into the App Id field. Click Lookup. The existing values for Title, App Domain and Redirect URL should appear.
Enter the following XML into the App's Permission Request XML field to specify required permissions. Then click Create.
You will be prompted to approve permissions for the app. Click Trust It.
Once the App is created, return to the CardioLog Analytics configuration screen and enter the details of the Client ID and Client Secret in the "Add the CardioLog Tracking Code to your Sites" step.
Select Automatically track all subsites including newly created ones in order to automatically enable tracking for newly created subsites under the selected site collections (in "Choose Sites to Track" step).
Select Notify me when client secret expires or is not working in order to receive an email alert to the specified email address. Follow these steps in order to renew the SharePoint App client secret if needed.
Click Save.
Click Install Tracking to install the tracking code on all selected site collections and their subsites.

Note: This step may take a while to complete, depending on the amount of selected sites. Follow the installation progress on the screen:
Click View installation report to view a detailed report of the installation progress. Click the top left down arrow icon to export the report to CSV.

Renew SharePoint App Client Secret

Execute the following PowerShell commands with the SharePoint Online Global Administrator account.
Edit the "Client ID" and use the Client ID value from the CardioLog Analytics configuration screen in "Add the CardioLog Tracking Code to your Sites" step.
In the same PowerShell window, execute the following PowerShell commands in order to generate a new client secret.
Copy the new client secret value and update it in the CardioLog Analytics configuration screen in the "Add the CardioLog Tracking Code to your Sites" step and click Save.

Install the tracking code automatically using a PowerShell script

Select this option to add the tracking code to all selected site collections (in "Choose Sites to Track" step) automatically using a PowerShell script.
Note: It is required to execute the PowerShell script every time you create new sites under the selected site collections in order to enable tracking for them.

Click CardioLog Analytics Tracking Deployment package to download the deployment package from the "Add the CardioLog 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.

Install the tracking code manually

Select this option to add the tracking code to specific sites manually.

Click CardioLog Analytics Tracking solution to download the deployment package from the "Add the CardioLog Tracking Code to your Sites" step in the Configuration page.
Right click the downloaded package zip file, select Properties > General and click on "Unblock" before unzipping it.
Temporarily allow custom scripts during the installation in order to add the JavaScript tracking code and Tracking Agent application (sppkg for modern sites, wsp solution for classic sites) to your app catalog and all of the site collections you wish to monitor.
Execute the following commands in the SharePoint Online Management Shell (edit your SharePoint admin center and site collection URLs).
1. Connect to SharePoint Online Admin Center with the SharePoint Online Global Administrator account:
2. Get the current value of the Custom Scripts setting DenyAddAndCustomizePages for each site collection you wish to monitor and for your App Catalog:
3. If the current value of DenyAddAndCustomizePages is Enabled, set it to Disabled:
4. Disconnect from SharePoint Online:
Browse to your SharePoint Online site collection Solution Gallery. The gallery should be found at the following address (replace the site collection root URL https://company.sharepoint.com/sites/site with yours): https://company.sharepoint.com/sites/site/_catalogs/solutions/forms/allitems.aspx
From your Solution Gallery, click Upload Solution > Choose File. Then select the CAI.wsp solution file which can be found in the deployment package and click Activate.
If you are presented with a request for access, make sure you have temporarily allowed custom scripts for your site collection and app catalog.
Once the solution is installed, return to the CardioLog Analytics configuration screen and click Copy script to copy the JavaScript tracking code.
Browse to CardioLog Analytics Integration solution configuration page. The page should be found at the following address (replace the site collection root URL https://company.sharepoint.com/sites/site with yours): https://company.sharepoint.com/sites/site/CardioLogAnalytics/Configuration.2.0.8.0.aspx
Paste the tracking code copied from the "Add the CardioLog Tracking Code to your Sites" step and click OK.
In order to track SharePoint Online modern sites and pages, install the Tracking Agent App:
1. Click CardioLog Analytics Tracking Agent App for modern sites to download the Tracking Agent App.
2. Upload the 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. Add the App to your site collection and to all of its subsites under Site Contents > New App
5. Click on Apps from your organization and click CardioLog Tracking Agent (it will be installed automatically)
After the installation is complete, revert the changes performed in step 3 (if any) and disable custom scripts.

Inject the tracking code to all site pages yourself

Select this option to inject the tracking code manually to your site pages.

Click Copy script to copy the JavaScript tracking code to the clipboard.
Paste the tracking code into the <head> section of each site page you would like to track.

Advanced Settings

Host the tracking code on a private CDN

By default the tracking code resources are hosted on Microsoft Azure. Select this option if you would like to host the tracking code resources on a private CDN for increased security.
Note: It is required to perform this step before adding the tracking code to selected sites.

Expand the Advanced Settings section in the "Add the CardioLog Tracking Code to your Sites" step.
Switch on the Host the tracking code on a private CDN toggle.
Enter the CDN Address and click Save.
Click Download CDN resources Here to download the latest version of the tracking code resources and host them on your private CDN.

Enable access to Power BI Reports via the Site Statistics option in SharePoint

Select this option if you would like to use the Site Level View feature to allow site owners to view and customize Power BI reports for their own sites only.
Note: It is required to perform this step before adding the tracking code to selected sites.

Expand the Advanced Settings section in the "Add the CardioLog Tracking Code to your Sites" step.
Switch on the Enable access to Power BI Reports via the Site Statistics option in SharePoint toggle.
Select the Permission level in SharePoint you would like to grant access to. Users with this permission level will have access to Power BI reports via the Site Statistics option under Site Actions in SharePoint.

Step 5: Connect to Power BI

In this step, you can connect to Power BI to gain access to your CardioLog Analytics reports.

Tenant Level View

The Tenant Level View feature allows administrators to view and customize Power BI reports for all selected site collections.

Note: The reports dataset size is limited based on your Power BI license. In case the limit is reached, upgrade your Power BI license or contact us to upgrade your subscription plan (to scale resources using Azure Analysis Services) or switch to the Site Level View feature.

Click Connect to Power BI and enter the Username and Password of a user with Power BI Pro or Power BI Premium Per User (PPU) license and click Save. This user will be the owner of the CardioLog Analytics SaaS app workspace in Power BI and will be able to share it with others in the organization.

CardioLog SaaS Configuration Screen: Step 5
Go to the Power BI interface.

Login with the credentials you entered in the "Connect to Power BI" step.
Create a Power BI app workspace for the CardioLog Analytics reports. Learn more about Power BI app workspaces.

Select Workspaces > Create a workspace
Enter the following details:
Name - CardioLog Analytics
Privacy - Private - Only approved members can see what's inside
Permissions - Members can edit Power BI content
Add email addresses of people you want to have access to the workspace, and select Add. Note that you can't add group aliases, just individuals.
Decide whether each person is a member or an admin (admins can edit the workspace itself, including adding other members, members can edit the content in the workspace) and click Save.

CardioLog Analytics reports will be available in your app workspace within a few business days. You will receive an email notification as soon as all the data has been processed and your reports are ready to use.
When the reports are ready, share them with your colleagues:
1. Sign in to Power BI with the credentials you entered in the "Connect to Power BI" step.
2. Select Workspaces > CardioLog Analytics > select the Create app button in the upper right to start the process of sharing all the content in that workspace.
3. First, on Setup tab, enter the following details:
  App name - CardioLog Analytics
  Description - Analytics for SharePoint and Office 365
4. Next, on Navigation, you see the reports that's going to be published as part of the app and organize the navigation pane.
5. Last, on Permissions, decide who has access to the app: either everyone in your organization, or specific people or email distribution lists and click Publish app.

Site Level View

The Site Level View feature allows site owners to view and customize Power BI reports for their own sites only.

Note: The reports dataset size is limited based on your Power BI license. In case the limit is reached, upgrade your Power BI license or contact us to upgrade your subscription plan (to scale resources using Azure Analysis Services) or split the reports.

Each site owner should browse to the configuration page hosted in Azure (URL provided by Intlock) in order to to connect to Power BI, or request access to reports for specific sites via the Site Statistics option in SharePoint.
Note: To enable the Site Statistics option in SharePoint, switch on the Enable access to Power BI Reports via the Site Statistics option in SharePoint toggle in Advanced Settings in the "Add the CardioLog tracking code to your sites" step.
Click Connect to Power BI and enter the Username and Password of your personal user (requires Power BI Pro or Power BI Premium Per User (PPU) license) and click Save. This user will be the owner of the CardioLog Analytics SaaS reports and will be able to share it with others in the organization.

CardioLog SaaS Configuration Screen: Connect to Power BI
Click Accept in the Permissions Requested screen to allow CardioLog Analytics SaaS publish the reports to your personal workspace.
Your request will be reviewed and approved/denied by your system administrator. The full list of site owners and the sites they are allowed to see reports for (in CSV format) can be downloaded/uploaded via the configuration page.

CardioLog SaaS Configuration Screen: Publish Power BI Reports to Site Owners
Once approved, CardioLog Analytics SaaS reports will be available in your personal workspace within a few business days. You will receive an email notification as soon as all the data has been processed and your reports are ready to use.
When the reports are ready, go to the Power BI interface.

Login with the credentials you entered in the "Connect to Power BI" step.
Select My Workspace > Reports > CardioLog Analytics SaaS

Step 6: Connect to Active Directory

In this step you can connect to your Azure Active Directory in order to import user information from Azure AD.

Login to SharePoint with the credentials of a global admin account that has permissions to sign in to Azure AD and read directory data (users' full profiles and groups).
Click Connect to Active Directory to connect to your Azure Active Directory with the current logged on user and click Save.

CardioLog SaaS Configuration Screen: Step 6
Select all user attributes that you would like to filter and report on. This information will be taken from Active Directory user attributes. If you have created custom user attributes you can also use them. It is recommended to select the following basic attributes - department, office, country, manager, title.
1. Using the search bar, enter the name of any attribute you would like to find and include.
2. Select the button next to each user property you would like to include in your usage reports.
3. Click Save to confirm your selection.
User attributes may be added or removed at any time to accommodate your needs.

Note: if you have already imported user information from SharePoint user profiles in step 2, there is no need to perform this step.
CardioLog SaaS Configuration Screen: Step 6

Step 7: Choose User Groups to Opt-out

In this step you can select which user groups you would like to opt-out of data collection.

The user group information will be taken from Azure Active Directory. It may take up to 24 hours for changes to take effect.

Connect to Azure Active Directory with an account that is a global administrator in your Office 365 tenant. This account will be used in order to approve the required permissions for CardioLog Analytics SaaS to connect to Azure Active Directory.
Click Accept to approve the required permissions.
Select the user groups you would like to opt-out of data collection and click Save.
Click Confirm to acknowledge that:
1. Data for opted out users, including user profile information and usage data, will be:
  1. Permanently deleted
  2. No longer collected
  3. No longer available in reports
2. Data for opted in users, including user profile information and usage data, will be collected and available in reports, however any data that was deleted/not collected during the time period they were opted out will not be recovered.
3. Using this functionality may result in data discrepancies in some reports.

Step 8: Assign Permissions to Power BI Reports

In this step you can select the users you would like to grant report permissions to and select the specific sites that they should see reports for.
The user information will be taken from Azure Active Directory. It may take up to 24 hours for changes to take effect.

Connect to Azure Active Directory with an account that is a global administrator in your Office 365 tenant. This account will be used in order to approve the required permissions for CardioLog Analytics SaaS to connect to Azure Active Directory.
Click Accept to approve the required permissions.
Select the users you would like to grant report permissions to. You can always go back and select additional users or remove users from your selection by clicking on -Remove user from list.
1. Using the Search for a user bar, enter the name of any user you would like to find and assign permissions to.
  Note: Selected users should have a Power BI Pro or Premium per User (PPU) license assigned to them.
2. For each user, click Custom to select the specific sites the user is allowed to see reports for, or click Access to all sites to select all sites.
3. Click Save to confirm your selections.
4. Share the CardioLog Analytics SaaS reports in Power BI service with the selected users.
  Note: Permissions are applied using Power BI Row Level Security (RLS). RLS does not apply to users who have edit permissions on the dataset.
5. Add the 'Site Analyst' role in Power BI service to users who have access to specific sites:
  CardioLog Analytics SaaS Dataset > More options > Security > Select the 'Site Analyst' role > Add each user as a member.
6. Add the 'Global Analyst (View All Sites)' role in Power BI service to users who have access to all sites:
  CardioLog Analytics SaaS Dataset > More options > Security > Select the 'Global Analyst (View All Sites)' role > Add each user as a member.
  Note: Since roles are reset in Power BI on every version update, it is highly recommended to create user groups for managing users roles (one for site analysts and one for global analysts) so it would be easier to maintain.

SharePoint On-Premise

Browse to the configuration page hosted in Azure (URL provided by Intlock).
The configuration contains a few simple steps that walk you through setting up data collection and connecting to Power BI reports.

CardioLog SaaS Configuration Screen

Step 1: Connect to SharePoint

Enter the SharePoint farm administrator user name and password and the SharePoint farm Admin Center URL and click Save.

CardioLog SaaS Configuration Screen: Step 1

Step 2: Choose Sites To Track

In this step you can select which site collections you would like to see data for. Site collections are only tracked once they are selected and the tracking code is deployed for them in the "Add the CardioLog Tracking Code to your Sites" step.

With this section expanded, you should see all of your available SharePoint web applications.
Expand each web application to select all the site collections you would like to begin monitoring using CardioLog.
You can also search for site collections by typing in their name in the search bar.
Select the button next to each site collection you would like to monitor.
In order to stop monitoring a site, unselect it. Note that this operation will remove the site from usage reports, but you will have to remove the tracking code from it manually.
In order to stop monitoring a site, but keep history data for it in usage reports, click on the folder icon next to it in order to archive it.
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 import process for large site collections may take a few hours up to a few days, depending on the environment size.