Adding the App

1. Once you have downloaded the K2 Cloud for SharePoint app, open your app catalog and navigate to the Apps for SharePoint page. (When you onboard as a new K2 Cloud customer, you receive an introduction email containing the download link for the SharePoint the K2 Cloud for SharePoint app. If you no longer have this link, please log a support ticket with Nintex Customer Central to obtain the download location for the app.)
   
2. Click Upload. On the Add document page, upload the K2 Cloud for SharePoint app, then click OK.
   
3. The K2 Cloud for SharePoint is now uploaded to your app catalog.
   
4. Next, navigate to your app catalog's Site Contents page and click New and select App.
   
5. On the Site Contents > Your Apps page, select the K2 Cloud for SharePoint app.
   
6. On the Do you trust K2 Cloud for SharePoint? page, click Trust It.
   
7. Once the app has been added to the app catalog, the app is available in the app catalog's Site Contents > Your Apps page.
   

Your next step is to register the app in the app catalog, as shown in the following section.

Follow these steps to register the app in the app catalog:

1. In the Site Contents > Your Apps of the app catalog, click the K2 Cloud for SharePoint app.
   
2. On the [App Catalog] > K2 for SharePoint > Settings > Registration Wizard page, specify a K2 URL and click Next.
   
3. Next the Registration Wizard will run. Click Finish once complete.
   

Your next step is to deploy the app to required site collections.

Follow the steps below to deploy the app to the required site collections:

1. On the [App Catalog] > K2 for SharePoint page, click the Manage App Deployments (SharePoint) link.
   
2. Next the Manage App Deployments > K2 Cloud for SharePoint page opens. On the Manage App Deployments page, there are two methods to deploy the app to the required site collections. Firstly, as described in step 3, using the Site Collections section where site collections can be individually specified, and secondly, as described in step 4, using the Managed Paths section where all site collections can be specified via the (All Paths) option. If you follow the Site Collections method (step 3) then the Managed Paths method (step 4) should not be used as it will deploy to all site collections.
   
   Best practice is to use the Managed Paths option to accomplish integration with SharePoint.
3. If specific site collections and their associated subsites are required for app deployment follow this step. In the Site Collections section, add the required site collections and click the Add button. Do not use the Managed Paths step as it will deploy to all site collections.
   
   Multiple site collections can be added at once, if required.
   
   
4. If all paths are required follow this step. In the Managed Paths section, select the (All Paths) option and click Add. This deploys the app to all site collections and associated subsites that reside in the farm/tenancy (All Paths) or under a valid path, such as sites. This is a more efficient and the recommended way to accomplish integration with SharePoint than step 3 where you specify site collections individually.
   
5. Click OK.
6. Next click the Trust It button on the Do you trust K2 Cloud for SharePoint page.
   

Your next step is to activate the app.

Follow these steps to activate the K2 for SharePoint app:

1. On the Site Contents page, click on the K2 Cloud for SharePoint app.
2. Click the Manage App Activations link on the [App Catalog] > K2 for SharePoint page.
   
3. Next, on the [App Catalog] > K2 for SharePoint > Settings > Manage App Activations page, set the default server and specify the required site collections for activation and click Activate. If the Enable auto-activation on sites where the app is deployed check box is deselected, you must activate the app from this page though the app appears on each site collection where the app is deployed.
   
4. Click the Trust It button.
   
5. Next the Activate Site Collection page opens and the specified site collection is activated. Notice that the site collection and all subsites now have the activated app.
   
   At activation time, all existing subsites in the site collection are activated with K2 for SharePoint. New subsites that are added at a later point, either manually or via a workflow, are also activated with K2 for SharePoint through the remote event receivers. This automatic activation may take a few minutes depending on your SharePoint environment. SharePoint Online instances do NOT include the remote event receiver, and hence do not get K2 for SharePoint automatically added to new subsites. For SharePoint Online you must reactivate the site collection using the Manage App Activations page, which finds the new subsites and only activates those.
6. When activating a site collection which contains a high number of subsites (50+), the activation may fail. To correct this issue click the Retry button on the Activate Site Collection page.
   
7. Multiple site collections can be activated all at once if required, just repeat the above steps on the Manage App Activations page.
   
   Ensure that if multiple site collections are required for activation, the app is deployed via the Manage App Deployments page first. For more information see KB001755 - K2 for SharePoint Deployment and Activation.
8. Click the Close button on the Activate Site Collection page.
9. Click the Close button Manage App Activations page.

To add the K2 Cloud for SharePoint app to a SharePoint environment see the Add topic.

To uninstall the K2 Cloud for SharePoint app, use the settings page on the app catalog. This removes the app from the specified site collection and its associated subsites. Follow the steps below to uninstall the app:

1. Open the app catalog site, click Site Contents.
2. On the Site Contents page click K2 Cloud for SharePoint app.
3. On the [App Catalog] > K2 for SharePoint page, click the Manage App Activations link.
   
   
4. On the Manage App Activations page select the required site collection where the app is currently installed and activated, and select it in the Uninstall section. Click the Uninstall button.
   
   
5. A Confirmation dialog appears, click OK.
   
6. The Uninstall Site Collection page opens and the uninstall begins automatically.
   When uninstalling the app from a site collection, all associated subsites that reside in the site collection, are also uninstalled.
   
7. Once the uninstall is complete, click the Close button.
   
   
8. Click the Close button on the Manage App Activations page.

To remove the K2 Cloud for SharePoint app from a SharePoint environment, the app must first be uninstalled. To do this see the Uninstall section.

After uninstalling the app, the app can be removed from the App Deployment section of the app settings. To do this follow the steps below:

1. Open the app catalog site and navigate to Site Contents > K2 Cloud for SharePoint.
2. On the [App Catalog] > K2 for SharePoint page, click the Manage App Deployments (SharePoint) link.
   
   
3. On the Manage App Deployments > K2 Cloud for SharePoint page, select the site collection to remove from the Site collections to deploy to: section and click the Remove button.
   
4. If you instead deployed using Managed Paths, click the paths you deployed to in the Managed paths to deploy to: section and then click the Remove button.
   
   
5. Click the OK button.
6. Next the Do you trust K2 Cloud for SharePoint? page opens, click the Trust it button.
   

If you want to remove the App and integration artifacts see Removing Artifacts and integration from SharePoint.