The K2 for SharePoint app enables K2 integration with SharePoint 2013, 2016 and SharePoint Online. If you have an existing K2 for SharePoint installation and need to upgrade that installation to a newer version of K2 or a newer version of the K2 for SharePoint App,  you can use this article to help you determine which procedure to follow, since the upgrade procedure will differ depending on what product you are using and the product versions you are upgrading to and from.

Quick Reference

The version that you currently have and the version that you are upgrading to determines the upgrade procedure. You can use the table below as a quick-reference guide to jump to the appropriate content for your product and version of K2, or otherwise review the Determining Your Upgrade Steps section below for more information. 

Product Upgrade Scenario Link
K2 Appit
  • Appit 1.5 Updates, e.g. when updating Appit 1.5 Update 4 to Appit 1.5 Update 5
  • From Appit 1.4 to Appit 1.5
Updating K2 for SharePoint (App Catalog-Registered App)
K2 blackpearl
  • From 4.6.x to 4.7
Updating K2 for SharePoint (App Catalog-Registered App)
  • From 4.6.x to 4.6.x
After Installing K2, Update the K2 for SharePoint App on each Site
  • From 4.7 to K2 Five
Upgrading to K2 Five

Determining Your Upgrade Steps

K2 Appit 1.4 was the first version to receive the app catalog-registered version of K2 for SharePoint. If you are upgrading to Appit 1.5 or later, remember that you must first add the new .app file to the app catalog. Then you can upgrade the app to the latest version. If you do not see the indication in SharePoint that there is a new version available, go into the Details page of the K2 Appit for SharePoint app.

Once the app is upgraded, run the Registration Wizard using the Registration Wizard link in the Administration section of the K2 for SharePoint page. If you do not see this link make sure you are browsing the app catalog. For more information see Upgrading K2 for SharePoint to an App Catalog-registered App Version

You do not have to deploy and activate the app to existing sites that have been previously integrated with K2. However, for new site collections and new subsites that must be integrated with K2, you must use the Administration links (Manage App Deployments and Manage App Activations) to deploy and activate the app to those new sites and site collections

K2 blackpearl 4.7 was the first version to receive the app catalog-deployed version of K2 for SharePoint. That means that when going from 4.6.x to 4.7 or later, you must carefully note the breaking changes and considerations.

Upgrading from 4.6.x to 4.7: See Upgrading K2 for SharePoint to an App Catalog-registered App Version (KB001738) to learn about considerations when using the app catalog-registered app. There are several considerations when upgrading, such as the change from App Parts to Web Parts.

Upgrading from 4.6.x to 4.6.x: If you are not upgrading to K2 blackpearl 4.7, see After Installing K2, Update the K2 for SharePoint App on each Site (KB001661) and register the app on every site in order to fully upgrade your environment.

K2 recommends that you upgrade to the latest version of K2 blackpearl.