If you have followed the steps above and find that the K2 app is either not deployed or not activated, use the following steps to configure the app. Depending on your environment, you may not have to perform all the steps below. If necessary, contact your K2 Cloud technical support for help.
Configuring the K2 Cloud for SharePoint app consists of the following steps:
Install > Register > Deploy > Activate
First, you must install and deploy the app to the root site collection App Catalog. This step is generally part of the K2 product installation or upgrade process and may already be complete.
Note that for customers new to the K2 Cloud environment, the K2 Cloud onboarding team will assist in installing and registering the app.
Deploying the K2 for SharePoint app during installation
After the K2 product installation or upgrade process completes, you must register the app against the K2 server. The third step is to deploy the app to the site collection(s) where you will allow (or trust) the app (which establishes permissions and connection between K2 and the site collection). After deploying the app, you can activate it for use in site collections, which simply means enabling features such as service instances, management SmartObjects, and list and library menu options. You can configure the deployment and activate steps to run automatically so that when you add new subsites, K2 discovers them, then deploys and activates the app for you. Once you have activated the app for a site collection, it is ready for use within the site and subsites.
- Confirm the app is installed by navigating to the root site collection's App Catalog. You can access this page via the SharePoint Central Administration > Apps menu. Generally speaking, you install the app during the SharePoint integration when installing or upgrading the K2 product. You should see the app listed under Apps for SharePoint. If it is not, contact your technical support team for assistance.
- Install the K2 Cloud for SharePoint app. K2 product installation steps can vary, depending on your K2 environment. Contact your support team for help with installing the app.
- Contact the K2 Cloud technical support team for questions regarding the app installation. The following instructions will use K2 Five as the demonstration images.
- From the App Catalog, navigate to the Site Contents.
![Site Contents](../../../Resources/Snippets/Tutorials/Images/Step1Images/003_4-7.png)
- Click the add an app icon.
- Under the Apps you can add heading, click the K2 Five for SharePoint icon. (The app may have a different name, depending on the K2 product you are working with.)
![Apps You Can Add](../../../Resources/Snippets/Tutorials/Images/Step1Images/004_FIVE.png)
- On the Do you trust K2 for SharePoint screen, click Trust It.(The app may have a different name, depending on the K2 product you are working with.)
![](../../../Resources/Snippets/Tutorials/Images/Step1Images/006_4-7.png)
K2 will add the app. During this time, the app icon will be grayed out with a message that reads K2 is adding the app. When you see the full-color icon, K2 has added the app. (The app icon may have a different name, depending on the K2 product you are working with.)
![K2 App Icons](../../../Resources/Snippets/Tutorials/Images/Step1Images/005_FIVE.png)
- Register the app against the K2 server. This step establishes the connection between the K2 Cloud for SharePoint app and the K2 server, along with authentication protocols. Click the app icon on the Site Contents page to launch the registration process. You will need the URL of your K2 server to complete this step.
- From the App Catalog > Site Contents page, click the K2 Cloud for SharePoint app icon to begin the registration process.
- On the Configure Link to K2 Server page, enter the URL to your K2 server. If you are on a K2-provided VM, the server URL is
https://k2.denallix.com
then click Next. If working in your own environment, enter the URL to your K2 server.
![](../../../Resources/Snippets/Tutorials/Images/Step1Images/008_4-7.png)
K2 will validate the URL. You will see the Configuring K2 Server Settings screen. This is where the configuration for authentication protocols, the SharePoint service broker and application settings take place.
If you see an error indicating a newer version of the app is available, you must update the current app before continuing.
- From the App Catalog, open Site Contents.
- Locate the K2 Cloud for SharePoint app, then click the ellipses and select About.
![](../../../Resources/Snippets/Tutorials/Images/Step1Images/007_FIVE.png)
- On the K2 for SharePoint page, click GET IT.
- Click TRUST IT on the Do you trust K2 for SharePoint pop-up.
- The installer will update the app to the current version.
- Re-run the registration wizard.
- Click Finish after you see a green check next to each configuration. You should be on the App Catalog > K2 Cloud for SharePoint page.
![Deploying the App](../../../Resources/Snippets/Tutorials/Images/Step1Images/009_4-7.png)
- Deploy the app to your site collections to make it available for activation at the site collection level. You can deploy the app to the root site collection, then activate it later to only those sites and subsites where you want to use it.
Now that you have registered the app, you will deploy it to any site collections where you want to use it. Unless you have security policies in place that dictate otherwise, deploy the app to the root site collection where you will use it. You can choose which sites and subsites to activate the app for later. This gives more granular control over where you can use the app.
To deploy the K2 Cloud for SharePoint app, K2 recommends you have Global Admin or Tenant Admin rights. You can only deploy the app from the App Catalog.
- On the App Catalog > K2 Cloud or SharePoint page, scroll down to the Administration heading. Click Manage App Deployments (SharePoint). (You can collapse the welcome section to make it easier to find, if you like.)
![](../../../Resources/Snippets/Tutorials/Images/Step1Images/010_4-7.png)
- You should be on the Manage App Deployments > K2 blackpearl for SharePoint page. Begin by entering the URL of the root site collection you are deploying the app to into the Enter a site collection to deploy to text box. If you are on a K2-provided VM, the site collection URL is
https://portal.denallix.com
then click Add (the button is just right of the text box). The site collection will be displayed in the Site collections to deploy to box.
Even if you created a subsite earlier, the best practice is to deploy the app at the root level. From there, you can activate the app to specific site collections or subsites if desired. At the root level, the app is available across all sites.
![](../../../Resources/Snippets/Tutorials/Images/Step1Images/012_4-7.png)
- In the Managed Paths section, click to highlight All Paths, then click the Add button just right of the Available managed paths box. See the image above for reference, if needed.
If you have managed paths within your SharePoint environment, you can select which paths should have the K2 app deployed to automatically. K2 recommends using the All Paths option so that the app deploys to any site collections or subsites when created. You can use the activation settings to control which site collections or subsites have the app automatically activated.
- In the Site Templates section, leave the default settings in place. You will not filter the K2 app deployment by site template. At the bottom of the screen, click OK. When you see the Do you trust K2 Cloudfor SharePoint screen, click Trust It. After the app deploys, you will redirect back to the App Catalog > Site Contents page.
- Activate the app to the sites and subsites where you want to use it. This gives you more granular control over where you can use the K2 app. Activating the app enables the app features such as system SmartObjects, as well the K2 group options located in the ribbon toolbar for lists and libraries. You will need your SharePoint site URLs for this step. If you are on a K2-provided VM, use https://portal.denallix.com.
At this point, you have deployed the app as a Global Admin, SharePoint Online or Tenant Admin. Activating the app requires site collection administrator permissions at a minimum. Confirm you have the necessary permissions before proceeding. Contact your SharePoint administrator if you have questions regarding your permission level. (If you are using a K2-provided VM, you are logged in as Administrator and can proceed)
- On the App Catalog > Site Contents page, click the K2 app icon. The icon may look slightly different than the image below, depending on your environment.
![](../../../Resources/Snippets/Tutorials/Images/Step1Images/005_FIVE.png)
- Under the Administration heading, click the Manage App Activations link.
![](../../../Resources/Snippets/Tutorials/Images/Step1Images/015_1-4.png)
On the Configure Activation Settings page, there are three sections to note. Under the Deployment section, there is an option to Enable auto-activation on sites where the app is deployed for any new site collections or subsites. By default, this option is set to TRUE, but you can deselect if you need to have more granular control over where the app is active.
The Activation text box is where you will enter the URL for the site collection you want the app activated for. K2 recommends activating the app at the root site collection. The Uninstall box displays site collections where the app is currently activated. Here, you can select a site collection and remove the app, if desired.
When you remove a site collection from the App Activation Settings, you are resetting SharePoint back to its pre-K2 app configuration. Any K2 artifacts (such as SmartObjects, SmartForms and workflows) that existed will still exist on the K2 server, however they will no longer be visible from the site collection.
![](../../../Resources/Snippets/Tutorials/Images/Step1Images/013_4-7.png)
- Begin by entering a site collection URL into the Activation text box, then click Activate. This may take a few minutes, depending on how many subsites you have within the site collection structure. If you are on a K2-provided VM, enter
https://portal.denallix.com
then click Activate.
![](../../../Resources/Snippets/Tutorials/Images/Step1Images/014_4-7.png)
The activation process begins. During this time, you will see a green check appear next to the SharePoint Service Broker section and then the Activation section as those features active. After both checks appear, your site collections and subsites will display under the Activate All heading, if you activated at the root site collection level. You should see a status of Activated. Click Close. Click Close once again to exit the Configure Activation Settings page.
![](../../../Resources/Snippets/Tutorials/Images/Step1Images/015_4-7.png)
- Confirm the app activation by returning to the test list you created in the first part of this topic. Click the LIST tab, then confirm the K2 group and icons are there.
If you can see the K2 group and icons, congratulations! You have successfully configured the K2 Cloud for SharePoint app and it is now ready for use. If for some reason, you cannot see the K2 group or icons, review the steps in this topic to determine if you missed a step. From there, contact your K2 Cloud technical support team for assistance.
- Navigate back to your SharePoint site or subsite and open the K2 App Test list you created earlier. Confirm there is now a K2 menu that has Application, Report and Worklist icons displayed. The K2 app is now ready for use!
![K2 Menu and Options](../../../Resources/Snippets/Tutorials/Images/Step1Images/004a_NewUI.png)
- How to update the app activation for new site collections. This step describes how to activate the K2 app for immediate use. During the K2 app deployment, you have the option for K2 to automatically apply the app to any new site collections. K2 schedules this "job" from a timer and depending on the settings, may not run for several minutes, or even hours. If you need to use the K2 app immediately in the new site collection, you can manually "push" the activation out to the site. From the Site Contents page, click the K2 app to launch the administration page. Under the Administration heading, click Activate Site Collection. The K2 app activates for the current site collection and is ready for use.
- After adding a new subsite or site collection, navigate to its Site Contents. Click the app to launch the K2 Cloud for SharePoint page.
If you do not see the K2 Cloud for SharePoint app in the Site Contents, the app is not deployed to the root site collection. Deploy the app first, then active it.
- Under the Administration heading, click Activate Site Collection.
You should see the activation processing screen. When complete, the app is ready for use. Remember, you must have site collection administrator permissions at a minimum to activate the app at the site collection level. You can also manually activate the app to a new subsite or site collection from the App Catalog. Follow the Activate steps for this scenario.