Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Launch CardioLog. If the Configuration Wizard doesn't launch automatically, you can run it manually by clicking on Administration in the Navigation pane and then selecting System Configuration. Click Configuration Wizard to restart CardioLog and begin the configuration process.
  2. In the Welcome dialog, select the desired UI language and date format. Under SharePoint Version, select SharePoint Online and then click Next.


    Configuration Wizard

  3. Anchor
    configuring tracking
    configuring tracking
    You can add the tracking code by either deploying the CardioLog tracking code through a SharePoint solution, OR manually adding the JavaScript tracking code to your master pages.

    Note: You may select only one option to add the tracking code.


    Configuration Wizard Step 2a: SharePoint Online Usage Tracking 

    Anchor
    deploy tracking
    deploy tracking
    Deploy the CardioLog tracking code through a SharePoint solution

    You can deploy the tracking code on all selected site collections automatically or add the tracking code to a specific site collection manually.

    Anchor
    auto_deploy
    auto_deploy
    Deploying the Tracking Code to all Selected Site Collections Automatically

    1. Once you complete the Configuration Wizard, go to the Administration section of the navigation pane, click System Configuration, select SharePoint Tree Adaptor and then select your SharePoint Online tenant.
    2. Click on Download button to download the automatic deployment Package.
      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.
    3. Right click the WSP-Tracking-Install-Script.zip file, select Properties > General and click on "Unblock" before unzipping it.
    4. Open the sites.json file and verify that all of the site collections you would like to track are included.
    5. Open the tracking.txt file and verify that the <cardiologserverdnsname> placeholders of the sourceDomain and eventListenerDomain fields that redirect to the CardioLog application server or dedicated tracking server have the public DNS name, appropriate port and secure protocol (HTTPS). The URLs should be accessible over the internet.
    6. 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).

    Anchor
    manual_deploy
    manual_deploy
    Add the Tracking Code to a Site Collection Manually 

    1. Browse to your SharePoint Online site Solution Gallery (Replace the website root URL with yours): [https://intlock.sharepoint.com]/_catalogs/solutions/forms/allitems.aspx

      solution.JPG
      'SharePoint Online' Site Solution Gallery

    2. Click Upload Solution > Choose File > select [CardioLog Installation Folder]\CardioLog\Configuration\AgentFeature\Online\Resources\CardioLog Analytics Integration.wsp > Activate
    3. Browse to CardioLog Analytics Integration solution configuration page (Replace the website root URL with yours): [https://intlock.sharepoint.com]/CardioLogAnalytics/Configuration.2.0.8.0.aspx

      configuration.JPG
      CardioLog Analytics Integration Solution Configuration Page

    4. Copy the code from the Tracking Code box in Step 2 of the Configuration Wizard.
    5. Edit the tracking code and verify that the all URLs contained in the tracking code that redirect to the CardioLog application/tracking server have the public DNS name and appropriate protocol. The URLs should be accessible over the internet. Use HTTPS if you are tracking secured SharePoint Online site collections. You may choose to use HTTP for public websites. 
    6. Add the JavaScript tracking code and click OK.

    Anchor
    uninstalling
    uninstalling
    Uninstalling the CardioLog Analytics Tracking Agent Feature

    You can choose between pausing and uninstalling the tracking code from your SharePoint online sites:

    1. To pause the tracking code, browse to your SharePoint Online site Solution Gallery (edit the website root URL): [https://intlock.sharepoint.com]/_catalogs/solutions/forms/allitems.aspx and deactivate the CardioLog Analytics Integration solution.
    2. To uninstall the tracking code, deactivate the CardioLog Analytics Integration solution and then delete the solution.


    Anchor
    manually add js
    manually add js
    Manually Add the JavaScript Tracking Code to Your Master Pages

    1. Open SharePoint Designer and add the SharePoint Online website: Go to Site Templates > Open Site > Enter website root URL (eg., - https://intlock.sharepoint.com/).
    2. Open Site Objects > Master Pages > *.master (we suggest the seattle.master page) and add the JavaScript tracking code in the <head> tag.
    3. Verify that all URLs contained in the tracking code that redirect to the CardioLog application/tracking server have the public DNS name and appropriate protocol. The URLs should be accessible over the internet. Use HTTPS if you are tracking secured SharePoint Online site collections. You may choose to use HTTP for public websites.

  4. In order to verify that your SharePoint Online pages are tracked, follow these steps:
    1. Open a new browser window and click Next Step.
    2. Delete your browser temporary internet files and click Next Step.
    3. Browse 3 pages on your SharePoint Online website and click Next Step.
    4. Click Test Event Collection. The Wizard will now verify usage events tracking.


    Step 2 - Usage Tracking


    Otherwise,

    1. Navigate to your SharePoint Online site homepage with Internet Explorer, Chrome, or FireFox.
    2. Press Ctrl+F5 to clear the cache and reload the page.
    3. While on the SharePoint website page, click Ctrl+F12. The tracking agent console should pop-up, displaying the ID number for the most recent monitored action (event). To close the console, press Ctrl+F12.
  5. Anchor
    tree structure
    tree structure
    In the SharePoint Adaptor dialog, enter a title and root URL of your SharePoint Online Admin Center. Specify the authentication details used to connect to it, then click Next. Loading your SharePoint Online tree structure may take several minutes to a few hours, depending on the number of items in the selected websites.

    Note: 
    Confirm that the CardioLog service account has the SharePoint Administrator role enabled in Office 365 Admin Center, under Customized Administrator.




    Configuration Wizard Step 3 - SharePoint Adaptor

  6. In the SharePoint Adaptor dialog, select the SharePoint website(s) you would like to report on, then click Next.



    Configuration Wizard Step 3 - SharePoint Adaptor Web Site Selection
     
  7. In the Usage Data Processing dialog, click Next.


    Configuration Wizard Step 4 - Usage Data Processing

  8. In the Finish dialog, click Finish. Click Show Raw Usage Data to view the usage events collected thus far. The data will be available in reports in the next hour.


    Configuration Wizard - Finish