In order to upgrade CardioLog Analytics, please follow the steps in this guide. Upgrading the application will not stop data collection. Contact us to receive the 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.
Upgrade Prerequisites
Prepare the following before the upgrade:
- Make sure you meet our system requirements.
- Contact us to receive a license code for the new version.
- 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
- If the CardioLog database is involved in database mirroring or an availability group, temporarily switch database synchronization off for the upgrade.
Running the Install Wizard
- Open CardioLog-Analytics-XXX.XXX.XXX.exe
- Follow the Installation Wizard steps.
- Run the IISReset command on the CardioLog application server.
- Apply the new product version license as detailed here.
- Start CardioLog Scheduling Service and CardioLog Diagnostics Service
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 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
- 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.
SharePoint Tree Adaptor Settings
- 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.
Update Tracking Agent Feature
Temporary downtime of SharePoint is required while updating the 'CardioLog Analytics' solution. In case you would like to update it manually:
- 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.
Update Tracking Agent Code - Update the 'CardioLog Analytics' solution:
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):
- Go to [CardioLog Installation Folder]\CardioLog\Configuration\AgentFeature\[SharePoint version]\
- 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)
Execute the following commands from command prompt in order to add and deploy the solution to the SharePoint farm (edit the directory path):
- Update the Tracking Agent code on the SharePoint WFE servers:
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\[language code]\core.js
For SharePoint 2010 only:
C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\LAYOUTS\[language code]\init.js
For SharePoint 2013 only:
C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\15\TEMPLATE\LAYOUTS\init.js
For SharePoint 2016 only:
C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\16\TEMPLATE\LAYOUTS\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"
SharePoint Online
Browse to your SharePoint Online site Solution Gallery (edit the website root URL): [https://intlock.sharepoint.com]/_catalogs/solutions/forms/allitems.aspx
SharePoint Online Site Solution Gallery
- Deactivate the CardioLog Analytics Integration solution and then delete it.
- Click Upload Solution > Choose File > select [CardioLog Installation Folder]\CardioLog\Configuration\AgentFeature\Online\CardioLog Analytics Integration.wsp > Activate
- Browse to CardioLog Analytics Integration solution configuration page (edit the website root URL): [https://intlock.sharepoint.com]/CardioLogAnalytics/Configuration.2.0.8.0.aspx
CardioLog Analytics Integration Solution Configuration Page
- Copy the tracking code from Administration > System Configuration > Usage Tracking Code > SharePoint Online.
- 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.
- Add the JavaScript tracking code and click OK.
- You can update the tracking code on all site collections in your SharePoint Online environment by publishing it.