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
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.
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.
You can go back and add more sites or remove sites from your selection at any point.
Note: The number of site collections available for selection in your subscription is limited.
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.
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
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.
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.
https://<Admin Center>/_layouts/15/
AppRegNew.aspx
(e.g. https://company-admin.sharepoint.com/_layouts/15/AppRegNew.aspx).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.
<AppPermissionRequests AllowAppOnlyPolicy="true"> <AppPermissionRequest Scope="http://sharepoint/content/tenant" Right="FullControl" /> <AppPermissionRequest Scope="http://sharepoint/content/sitecollection" Right="FullControl" /> <AppPermissionRequest Scope="http://sharepoint/content/sitecollection/web" Right="FullControl" /> </AppPermissionRequests> |
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).
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.
Connect-MsolService $clientId = "Client ID" $keys = Get-MsolServicePrincipalCredential -AppPrincipalId $clientId $keys Remove-MsolServicePrincipalCredential -KeyIds $keys.KeyId -AppPrincipalId $clientId |
In the same PowerShell window, execute the following PowerShell commands in order to generate a new client secret.
$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 |
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.
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.
Select this option to add the tracking code to specific sites manually.
Connect to SharePoint Online Admin Center with the SharePoint Online Global Administrator account:
Connect-SPOService -Url https://company-admin.sharepoint.com |
Get the current value of the Custom Scripts setting DenyAddAndCustomizePages for each site collection you wish to monitor and for your App Catalog:
Get-SPOsite https://company.sharepoint.com | Select DenyAddAndCustomizePages |
If the current value of DenyAddAndCustomizePages is Enabled, set it to Disabled:
Set-SPOsite https://company.sharepoint.com -DenyAddAndCustomizePages 0 |
Disconnect-SPOService |
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:
Click CardioLog Analytics Tracking Agent App for modern sites to download the Tracking Agent App.
Upload the CardioLogTrackingAgentAddin.sppkg app to the SharePoint Admin apps > App Catalog > Apps for SharePoint > New.
Click Deploy (do NOT select "Make this Solution available to all sites in the organization")
Add the App to your site collection and to all of its subsites under Site Contents > New App
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.
Connect-SPOService -Url https://company-admin.sharepoint.com Set-SPOsite https://company.sharepoint.com -DenyAddAndCustomizePages 1 Disconnect-SPOService |
Note: If you would like to edit the tracking code via the CardioLog Analytics Integration solution configuration page (https://company.sharepoint.com/sites/site/CardioLogAnalytics/Configuration.2.0.8.0.aspx), you will have to temporarily enable custom scripts again.
Select this option to inject the tracking code manually to your site pages.
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.
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.
In this step, you can connect to Power BI to gain access to your CardioLog Analytics reports.
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.
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.
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
In this step you can connect to your Azure Active Directory in order to import user information from Azure AD.
Using the search bar, enter the name of any attribute you would like to find and include.
Select the button next to each user property you would like to include in your usage reports.
Click Save to confirm your selection.
User attributes may be added or removed at any time to accommodate your needs.
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.
In this step you can select which content (subsites and lists) you would like to opt-out of data collection. You can always go back and select additional subsites/lists or remove subsites/lists from your selection.
The subsites and lists available for selection are taken from the list of site collections selected in step 1.
Note: It may take up to 24 hours for changes to take effect.
Choose Subsites or Lists to Exclude Step
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.
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.
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.
Click Save to confirm your selections.
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.
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.
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.
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
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.
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.
You can go back and add more sites or remove sites from your selection at any point.
Note: The number of site collections available for selection in your subscription is limited.
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.
CardioLog SaaS Configuration Screen: Step 2
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 3
CardioLog SaaS Configuration Screen: Step 3 - Choose User Attributes with PII Concealment
CardioLog SaaS Configuration Screen: Step 4
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.
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.
Execute the Run_Script.ps1 script in Windows PowerShell on the SharePoint central admin server (do not use Windows PowerShell ISE version). Make sure to close all browser windows on your machine before executing the script.
Note: SharePoint farm administrator and a local administrator on the SharePoint central admin server and WFEs is required. If deploying the tracking code on modern sites in SharePoint 2019, the user account must be a member of the sites Owners group and Full Control permissions on the App Catalog.
Select this option to add the tracking code to specific sites manually.
Create a CardioLogAgent folder on all SharePoint WFE servers in the following location: C:\Program Files\Common Files\Microsoft Shared\web server extensions\14\TEMPLATE\LAYOUTS\CardioLogAgent (do not convert it to application in IIS).
Execute the following commands from command prompt in order to add and deploy the solution to your SharePoint farm:
cd C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\1X\BIN stsadm.exe -o addsolution -filename "C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\1X\BIN\CardioLogTrackingAgentFeature.wsp" stsadm.exe -o deploysolution -name CardioLogTrackingAgentFeature.wsp -immediate -allowgacdeployment stsadm.exe -o activatefeature -name CardioLogAnalytics -force |
Upload the CardioLogTrackingAgentAddin.sppkg app to the SharePoint App Catalog > Apps for SharePoint > New.
Click Deploy
Add the App to your site collection and to all of its subsites under Site Contents > New App
Click on Apps from your organization and click CardioLog Tracking Agent (it will be installed automatically)
Once the CardioLog Tracking Agent app is installed, it is automatically activated and data is being collected. To view the installed app, go to the monitored site > Site Contents > CardioLog Tracking Agent.
Select this option to inject the tracking code manually to your site pages.
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.
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.
In this step, you can connect to Power BI to gain access to your CardioLog Analytics reports.
The Farm 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 6
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.
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.
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
In this step you can connect to your Active Directory in order to import user information from AD.
CardioLog SaaS Configuration Screen: Step 7
Please note that port 389 (LDAP)/port 636 (SLDAP) and the AD domain controller IP and FQDN should be available.
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.
Using the search bar, enter the name of any attribute you would like to find and include.
Select the button next to each user property you would like to include in your usage reports.
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 3, there is no need to perform this step.
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 Active Directory. It may take up to 24 hours for changes to take effect.
Go to the Yammer Apps Directory and search for CardioLog Analytics SaaS, then click Try it.
Click Allow in the Connect to CardioLog Analytics SaaS screen to allow CardioLog Analytics SaaS to retrieve data from your Yammer network, then you will be redirected to the configuration page.
Connect to your Yammer network with a dedicated service account that is a Verified Admin in your Yammer network.
Connect to Microsoft Graph API with an account that is a global administrator in your Office 365 tenant to gather analytics data for Yammer.
Note: This account will be used in order to approve the required permissions for CardioLog Analytics SaaS to connect to Microsoft Graph API (User.Read and Reports.Read.All).
In this step you can select all user attributes that you would like to filter and report on. This information will be taken from the Yammer user profiles.
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.
In this step, you can connect to Power BI to gain access to your CardioLog Analytics reports.
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.
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 app 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:
Once you have installed the CardioLog Analytics SaaS add-in 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
In this step, you can connect to Power BI to gain access to your CardioLog Analytics reports.
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.
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 app 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:
In this step you can select which Teams you would like to see data for in reports.