Versions Compared

Key

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

In order to upgrade CardioLog Analytics, you must uninstall your current version before installing the new version. Uninstalling please follow the steps in this guide. Upgrading the application will not stop data collection. Contact us to receive the detailed upgrade procedure and license codes required for your new version. 

Note: Support is provided for product versions released within the past 18 months. Please review the Intlock Support Policy.

Contents

...

 

Table of Contents

Upgrade Prerequisites

Prepare the following before the upgrade:

  1. Make sure you meet our system requirements.
  2. Contact us to receive a license code for the new version. 
  3. Create a full backup of the following:
    • CardioLog Database
    • CardioLog Installation Folder (by default it is located on the CardioLog application server in C:\Program Files\Intlock\CardioLog)
    • CardioLog Tracking Agent Folder (by default it is located on the SharePoint WFEs in C:\Program Files\Common Files\microsoft shared\Web Server Extensions\14\TEMPLATE\LAYOUTS\CardioLogAgent)
    • CardioLog website bindings in IIS
  4. If the CardioLog database is involved in database mirroring or an availability group, temporarily switch database synchronization off for the upgrade.

Anchor
install
install
Running the Install Wizard

  1. Open CardioLog-Analytics-2XXX.0.XXX.XXX.exe
  2. Follow the Installation Wizard steps.
  3. Start CardioLog Scheduling Service and CardioLog Diagnostics Service
  4. Run the Run the IISReset command on the CardioLog application server and check the status to confirm that IIS stopped and restarted.

Note: If you are upgrading from versions lower than 2.0.3.0:
Upgrade your product to version 2.0.3.0 first.

Note: If you are upgrading from versions lower than 2.0.2.0:
Install the following components on the CardioLog server:

  1. Microsoft .NET Framework 3.5 Service Pack 1
  2. Microsoft Chart Controls for Microsoft .NET Framework 3.5

Microsoft provides these downloads here

Note: If you are upgrading from versions lower than 1.19.158.0:

For Windows Server 2003 x64 with IIS 6.0, make sure IIS runs in 64-bit mode.
For Windows Server 2008 x64 with IIS 7.0, make sure that the CardioLog application pool runs in 64-bit mode:

  1. Open IIS Manager go to Application Pools, and right-click CardioLogApplicationPool
  2. Select Advanced Settings from the contextual menu > Click Enable 32-bit Applications and select False
  3. Click OK > Right-click CardioLogApplicationPool again, and then select Recycle
  1. Apply the new product version license as detailed here.
  2. Start CardioLog Scheduling Service and CardioLog Diagnostics Service


Anchor
upgrading
upgrading
Upgrading the Tracking Agent

If you have customized the Tracking Agent code in your environment, which is often done if you use a custom search feature on your site, please contact us before upgrading

your product.

For SharePoint Online, see how to update the tracking code for SharePoint Online.  

Anchortracking codetracking codeUpdating the tracking code:Backup the Java Script tracking code by manually saving a copy in a separate folder. By default, the JavaScript tracking code is embedded within a common JavaScript file on all of your SharePoint WFEs (Web Front Ends), which typically is one of the following locations relevant to your software versions: For MOSS 2007 only:

the tracking agent.

SharePoint On-Premise

Update the Tracking Agent according to the method you chose to embed the Tracking Agent code in your SharePoint farm when you configured CardioLog:

Deploy the CardioLog Tracking Code Through a SharePoint Solution

  1. To automatically update the 'CardioLog Analytics' SharePoint solution and Tracking Agent code open CardioLog Analytics > Administration > System Configuration > SharePoint Tree Adaptor > click on the SharePoint farm > Additional Actions > Click on Update Tracking Feature.

    Image Added
    SharePoint Tree Adaptor Settings
     
  2.  Select Farm > Click on Update.
    This action will automatically retract and remove the 'CardioLog Analytics' solution from the farm, deploy the new solution, and update the tracking agent code located on the SharePoint WFE servers.
    Note
    : The following permissions and roles are required for the CardioLog user account to update the 'CardioLog Analytics' solution - SharePoint farm administrator, a local administrator on the SharePoint application server and WFEs and "db_owner" on the SharePoint config database.

    Image Added 

    Update Tracking Agent Feature

    Temporary downtime of SharePoint is required while updating the 'CardioLog Analytics' solutionIn case you would like to update it manually:
For SharePoint 2010 only:
    1. Update the Tracking Agent code on the SharePoint WFE servers:
      In the navigation pane, go to Administration > System Configuration > SharePoint Tree Adaptor > click on the SharePoint farm > Additional Actions > Click on Update Tracking Feature and select Web Front End > Enter the WFE server names and click on Update.

      Image Added
      Update Tracking Agent Code

    2. Update the 'CardioLog Analytics' solution:
      1. Execute the following commands from command prompt on the SharePoint application server in order to deactivate the feature, retract and remove the solution from your SharePoint farm (edit the directory path: 1X - 12 for MOSS 2007, 14 for SharePoint 2010, 15 for SharePoint 2013, 16 for SharePoint 2016):

        Info
        iconfalse

        cd C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\

12\TEMPLATE\LAYOUTS\1033\core.js
      1. 1X\BIN

        stsadm -o deactivatefeature -force -name "CardioLogAnalytics"

        stsadm -o uninstallfeature -force -name "CardioLogAnalytics"

        stsadm -o retractsolution -immediate -name "CardioLogTrackingAgentFeature.wsp"

        stsadm -o execadmsvcjobs

        stsadm -o deletesolution -override -name "CardioLogTrackingAgentFeature.wsp"

        stsadm -o execadmsvcjobs

      2. Go to [CardioLog Installation Folder]\CardioLog\Configuration\AgentFeature\[SharePoint version]\
      3. Copy the solution file "cardiologtrackingagentfeature.wsp" to your SharePoint application server to C:\Program Files\Common Files\Microsoft Shared\web server extensions\1X\BIN folder (1X - 12 for MOSS 2007, 14 for SharePoint 2010, 15 for SharePoint 2013, 16 for SharePoint 2016)
      4. Execute the following commands from command prompt in order to add and deploy the solution to the SharePoint farm (edit the directory path):

        Info
        iconfalse

        cd C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\

14\TEMPLATE\LAYOUTS\1033\init.js
For SharePoint 2013 only:
      1. 1X\BIN

        stsadm.exe -o addsolution -filename "C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\

15
      1. 1X\

TEMPLATE
      1. BIN\

LAYOUTS\init.js
For MOSS 2007 with "CardioLog Analytics" SharePoint Feature only
      1. CardioLogTrackingAgentFeature.wsp"

        stsadm.exe -o deploysolution -name CardioLogTrackingAgentFeature.wsp -immediate -allowgacdeployment

        stsadm.exe -o activatefeature -name CardioLogAnalytics -force

Add the JavaScript Tracking Code to SharePoint common JavaScript files or master pages

Replace the Java Script tracking code with the one found in your CardioLog application. In the navigation pane, go to Administration > System Configuration > Usage Tracking Code (select your SharePoint version).

By default, the JavaScript tracking code is embedded within a common JavaScript file on all of your SharePoint WFEs (Web Front Ends), which typically is one of the following locations relevant to your software versions:

For MOSS 2007 only:
C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\12\TEMPLATE\LAYOUTS\

CardioLogAgent

[language code]\

CardioLogAgent

core.js

For SharePoint 2010

with "CardioLog Analytics" SharePoint Feature only

only:
C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\LAYOUTS\

CardioLogAgent

[language code]\

CardioLogAgent

init.js

For SharePoint 2013

with "CardioLog Analytics" SharePoint Feature only

only:
C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\

14

15\TEMPLATE\LAYOUTS\

CardioLogAgent\CardioLogAgent

init.js

OR


For SharePoint 2016 only:
C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\

15

16\TEMPLATE\LAYOUTS\

CardioLogAgent\CardioLogAgent

init.js

  


 

The tracking code is located at the end of the file, between these comments: "//Intlock tracking code start" and "//Intlock tracking code end"

 Replace the Java Script tracking code with the one found in your CardioLog application or SharePoint Marketing Suite. In the navigation pane, go to Administration > System Configuration > Usage Tracking Code (select your SharePoint version).
For the CardioLog Analytics SharePoint Feature only:
Edit the Java Script tracking code - replace all the occurrences of http://[server name]:[port]/ (This will be the name of your CardioLog server name and port number) with /_layouts/.
 
Anchortracking agenttracking agentUpdating Remote Tracking Agent Files:

If you have tracking agent files that reside on your SharePoint WFEs (Usually located under "_layouts" if you use the CardioLog Analytics SharePoint Feature), update the CardioLog tracking agent files:

  1. Create a backup of the CardioLogAgent directory, located on all of your SharePoint WFEs, by saving the directory to a separate folder or disk.
  2. Copy all installation files from [CardioLog Installation Directory]\CardioLogAgent to the existing CardioLogAgent directory, except the web.config file and custom files. If you have customized the Tracking Agent code in your environment, which is often done to enable custom search, please contact us before replacing the files.
  3. Edit the following keys in the CardioLogAgent\web.config file, located under the <appSettings> section -

<add key="CardioLogAgentRoot" value="/_layouts"/> 

<add key="version" value="2.0.8.3"/> 

  1. Add the following keys to the CardioLogAgent\web.config file, located under the <appSettings> section -

<add key="UseSPAuth" value="false"/>
<add key="FixClaimsUserAccountRegex" value="^(.*[|])(.*)$"/>

If your tracking agent is configured to identify authenticated users by retrieving their sign-in user name from SharePoint (See Tracking Agent Configuration for more information):
  1. Delete the following key from the CardioLogAgent\web.config, located under the <appSettings> section:

<add key="GetUserNameCustom" value=" function GetUsername() { __trace(&quot;GetUsername&quot;); var currentUsername = __readCookie(&quot;_userid&quot;); var currentUserId = __readCookie(&quot;spUserid&quot;); if (typeof(_spPageContextInfo) != &quot;undefined&quot;) { if (!currentUserId || currentUserId != _spPageContextInfo.userId) { currentUsername = null; __saveCookie(&quot;spUserid&quot;, _spPageContextInfo.userId, 1000, element.CookieDomain); } } var useridInput = this.document.getElementById(&quot;userid&quot;); if (useridInput &amp;&amp; useridInput.value != &quot;&quot;) { currentUsername = useridInput.value; } else if (currentUsername == null || currentUsername == &quot;&quot;) { if (typeof (getSPUserAccount) != &quot;undefined&quot;) { currentUsername = getSPUserAccount(); } else { currentUsername = &quot;Anonymous_&quot;+Math.random()*100000; } } __saveCookie(&quot;_userid&quot;, currentUsername, 1000, element.CookieDomain); __trace(&quot;GetUsername return: &quot;+currentUsername); return currentUsername; }"/>

  1. Edit the following key in the CardioLogAgent\web.config, located under the <appSettings> section:
<add key="UseSPAuth" value="true"/>

SharePoint Online

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

    solution.JPGImage Added 
    SharePoint Online Site Solution Gallery
     

  2. Deactivate the CardioLog Analytics Integration solution and then delete it.
  3. Click Upload Solution > Choose File > select [CardioLog Installation Folder]\CardioLog\Configuration\AgentFeature\Online\CardioLog Analytics Integration.wsp > Activate
  4. Browse to CardioLog Analytics Integration solution configuration page (edit the website root URL): [https://intlock.sharepoint.com]/CardioLogAnalytics/Configuration.2.0.8.0.aspx

    configuration.JPGImage Added 
    CardioLog Analytics Integration Solution Configuration Page
     
  5. Copy the tracking code from Administration > System Configuration > Usage Tracking Code > SharePoint Online. 
  6. Edit the tracking code and verify that the all URLs contained in the tracking code that redirect to the CardioLog application 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 and http for public websites.
  7. Add the JavaScript tracking code and click OK.
  8. You can update the tracking code on all site collections in your SharePoint Online environment by publishing it