CardioLog SaaS Configuration Guide

Step 2: Choose User Properties To Report On

 What are SharePoint Profiles?

1. Using the search bar, enter the name of any property 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.

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

CardioLog SaaS Configuration Screen: Step 2

Step 3: Choose Content Metadata Fields to Report On

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. 

You can add the tracking code to specific sites or deploy it on all selected site collections automatically.

CardioLog SaaS Configuration Screen: Step 4

Deploying the Tracking Code to all Selected Site Collections Automatically

1. Download the automatic 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.
2. Right click the downloaded package zip file, select Properties > General and click on "Unblock" before unzipping it.
3. Execute the Run_Script.ps1 script in PowerShell (you must have the MS Online module installed and the credentials of the SharePoint Online global administrator).

Add the Tracking Code to a Site Collection Manually

1. Browse to your SharePoint Online site Solution Gallery. The gallery should be found at this address by replacing the website root URL with yours: <https://company.sharepoint.com]/_catalogs/solutions/forms/allitems.aspx>
2. From your Solution Gallery, click Upload Solution > Choose File. Then select CardioLog Analytics Integration.wsp and click Activate.
3. If you are presented with a request for access, go to the Admin Center, found under the Office 365 Admin menu.
   1. From the SharePoint Admin Center select Settings.
   2. Choose Custom Script.
   3. Select Allow for both options. (Allow users to run custom script on personal sites & Allow users to run custom script on self-service created sites)
   4. The preference change may take up to 24 hours.
      1. In order to force the change to take place immediately, you may download and run the SharePoint Online Management Shell.
      2. Follow Microsoft's instructions for connecting it to your SharePoint Online tenant, 
      3. Run the following shell command:
         
         Set-SPOsite <SiteURL> -DenyAddAndCustomizePages 0
         
         

4. Once the solution is installed, return to the CardioLog Analytics configuration screen and copy the JavaScript tracking code.

5. Browse to CardioLog Analytics Integration solution configuration page. The page should be found at this address by replacing the website root URL with yours: <https://company.sharepoint.com]/CardioLogAnalytics/Configuration.2.0.8.0.aspx>

6. Paste the tracking code copied from the "Add the CardioLog Tracking Code to your Sites" step and click OK.

7. To enable support for tracking SharePoint Online modern sites and pages, install the Tracking Agent App:

   1. Download the automatic deployment package from the "Add the CardioLog Tracking Code to your Sites" step in the configuration page.

   2. Upload 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. Go to the tracked Site Collection > Site Contents > New App

   5. Click on Apps from your organization and click CardioLog Tracking Agent (it will be installed automatically)

Note: The tracking code contains links to the Events Listener web application in Azure.

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.

1. Click Connect to Power BI and enter the Username and Password of a Power BI Pro user 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
   
   

2. Go to the Power BI interface. 

1. Login with the credentials you entered in the "Connect to Power BI" step.

2. Create a Power BI app workspace for the CardioLog Analytics reports. Learn more about Power BI app workspaces.

1. Select Workspaces > Create a workspace
   

2. Enter the following details:
   Name - CardioLog Analytics
   Privacy - Private - Only approved members can see what's inside
   Permissions - Members can edit Power BI content

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

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

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

4. 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 Worksaces > CardioLog Analytics > select the Publish app button in the upper right to start the process of sharing all the content in that workspace.
      
   3. First, on Details, enter the following details:
      Description - Analytics for SharePoint and Yammer
      Background color - Gray
   4. Next, on Content, you see the content that's going to be published as part of the app. Select Specific content in the App landing page. 
   5. Last, on Access, decide who has access to the app: either everyone in your organization, or specific people or email distribution lists and click Finish.

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.

1. Each site owner should browse to the configuration page hosted in Azure (URL provided by Intlock) in order to to connect to Power BI.

2. Click Connect to Power BI and enter the Username and Password of your personal Power BI Pro user 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
   
   

3. Click Accept in the Permissions Requested screen to allow CardioLog Analytics SaaS publish the reports to your personal workspace.
   
   
   
   

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

5. When the reports are ready, go to the Power BI interface. 

1. Login with the credentials you entered in the "Connect to Power BI" step.

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

1. 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). 
2. 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
   
   
3.  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
   

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

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

1. With this section expanded, you should see all of your available SharePoint web applications.
2. Expand each web application to select all the site collections you would like to begin monitoring using CardioLog.
   
3. You can also search for site collections by typing in their name in the search bar.
4. Select the button next to each site collection you would like to monitor.
5. 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.

 
CardioLog SaaS Configuration Screen: Step 2

Step 3: Choose User Properties To Report On 

 What are SharePoint Profiles?

1. Using the search bar, enter the name of any property 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.

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

 
CardioLog SaaS Configuration Screen: Step 3

Step 4: Choose Content Metadata Fields to Report On

CardioLog SaaS Configuration Screen: Step 4

Step 5: Add The Tracking Code To Your Sites

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

You can add the tracking code to specific sites or deploy it on all selected site collections automatically.

CardioLog SaaS Configuration Screen: Step 5

Deploying the Tracking Code to all Selected Site Collections Automatically

1. Download the automatic 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.
2. Right click the downloaded package zip file, select Properties > General and click on "Unblock" before unzipping it.

3. Execute the Run_Script.ps1 script in PowerShell on the SharePoint central admin server.
   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.

Add the Tracking Code to a Site Collection Manually

1. 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).
2. Create a CardioLogAgent.js file in the CardioLogAgent folder with the JavaScript tracking code. Copy the JavaScript tracking code from the"Add the CardioLog Tracking Code to your Sites" step.
3. Copy the CardioLog Analytics Tracking solution file "cardiologtrackingagentfeature.wsp" to your SharePoint application server to C:\Program Files\Common Files\Microsoft Shared\web server extensions\1X\BIN folder (1X - 15 for SharePoint 2013, 16 for SharePoint 2016 and SharePoint 2019)

4. Execute the following commands from command prompt in order to add and deploy the solution to the 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

Step 6: Connect to Power BI

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

Farm Level View

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.

1. Click Connect to Power BI and enter the Username and Password of a Power BI Pro user 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
   
   

2. Go to the Power BI interface.

1. Login with the credentials you entered in the "Connect to Power BI" step.

2. Create a Power BI app workspace for the CardioLog Analytics reports. Learn more about Power BI app workspaces.

1. Select Workspaces > Create a workspace

2. Enter the following details:
   Name - CardioLog Analytics
   Privacy - Private - Only approved members can see what's inside
   Permissions - Members can edit Power BI content

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

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

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

4. 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 Worksaces > CardioLog Analytics > select the Publish app button in the upper right to start the process of sharing all the content in that workspace.
      
   3. First, on Details, enter the following details:
      Description - Analytics for SharePoint and Yammer
      Background color - Gray
   4. Next, on Content, you see the content that's going to be published as part of the app. Select Specific content in the App landing page. 
   5. Last, on Access, decide who has access to the app: either everyone in your organization, or specific people or email distribution lists and click Finish.

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.

1. Each site owner should browse to the configuration page hosted in Azure (URL provided by Intlock) in order to to connect to Power BI.
2. Click Connect to Power BI and enter the Username and Password of your personal Power BI Pro user 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
   
   

3. Click Accept in the Permissions Requested screen to allow CardioLog Analytics SaaS publish the reports to your personal workspace.
   
   
   
   

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

5. When the reports are ready, go to the Power BI interface. 

1. Login with the credentials you entered in the "Connect to Power BI" step.

2. Select My Workspace > Reports > CardioLog Analytics SaaS

Step 7: Connect to Active Directory

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

1. Enter the credentials of an account that has read access to Active Directory and the Active Directory domain controller name (FQDN) and click Save.
   

   
   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.
   
   

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

CardioLog SaaS Configuration Screen: Step 7

Yammer

Step 1 : Register a New Yammer App

Go to the Created Apps page: https://www.yammer.com/client_applications

Click Register New App For more information see "Yammer App Registration"

Fill out the following fields within the submission form:

1. Application Name - A unique name in Yammer, i.e. CardioLogAnalytics-companyname  

Organization - The name of your organization

Support e-mail - An email address which users of your app can contact for support

Website - Your organization's website

Redirect URI - A URL to redirect the user's browser to, after the user has linked the application to their Yammer account, i.e. https://www.yammer.com/client_applications

Save changes to finish registering the app.

Microsoft Teams

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

Step 1: Connect to Power BI

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 Power BI Pro user 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.

1. Login with the credentials you entered in the "Connect to Power BI" step.

2. Create a Power BI app workspace for the CardioLog Analytics reports. Learn more about Power BI app workspaces.

   1. Select Workspaces > Create app workspace

   2. Enter the following details:
      Name - CardioLog Analytics
      Privacy - Private - Only approved members can see what's inside
      Permissions - Members can edit Power BI content

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

   4. 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 Worksaces > CardioLog Analytics > select the Publish app button in the upper right to start the process of sharing all the content in that workspace.
   
3. First, on Details, enter the following details:
   Description - Analytics for SharePoint and Yammer
   Background color - Gray
4. Next, on Content, you see the content that's going to be published as part of the app. Select Specific content in the App landing page. 
5. Last, on Access, decide who has access to the app: either everyone in your organization, or specific people or email distribution lists and click Finish.

Step 2: Connect to Teams

Connect to Teams with a dedicated service account that is a global administrator in your Office 365 tenant. This account will be added as a member to selected Teams in order to track them.

Step 3: Choose Teams To Track

In this step you can select which Teams you would like to see data for.

With this section expanded, you should see all of your available Teams.

Select all the Teams you would like to begin monitoring using CardioLog.

You can also search for Teams by typing in their name in the search bar.

Select the button next to each Team you would like to monitor.

Click Save to confirm your selection.

You can go back and add more Teams or remove Teams from your selection at any point.

Please note that the import process for large Teams may take a few hours up to a few days, depending on the environment size.