Introduction

K2 for SharePoint is a business app that seamlessly integrates with SharePoint, on-premises or in the cloud enabling you to build simple workflows within SharePoint or complex applications that simply use SharePoint as a line-of-business system.

Important: If you have a version of K2 for SharePoint later than this version and need to update to the that version, please see Updating the K2 for SharePoint App (http://help.k2.com/KB001661) for detailed instructions.

Download

K2 for SharePoint can be downloaded from the K2 blackpearl downloads available on the K2 Partner and Customer Portal site. There is one package that once extracted will provide you with all the K2 installers required to run K2 for SharePoint, or you can download the K2 for SharePoint component as a separate installer. See the Installation details below for more information.

Known Issues

A list of some of the current known issues that you may encounter when using K2 for SharePoint is available in the Known Issues List.

Important Considerations

A. K2 for SharePoint Online Preview

K2 for SharePoint when installed on SharePoint Online will soon support the Microsoft Common Consent Framework to provide a consistent experience for the administrators and users of the app.  For more information on the Common Consent Framework, please see: http://msdn.microsoft.com/en-us/library/office/dn605895(v=office.15).aspx. The Common Consent Framework is available in preview today and is currently not supported for production systems.

K2 for SharePoint when installed on SharePoint Online will currently be offered as a preview until such time that the Common Consent Framework can be fully supported, currently targeting the next K2 blackpearl release.  The preview is upgradable and supported with the following restriction.

  1. K2 for SharePoint utilizes a user and app policy which requires the user and the app to have the same rights for all interactions, including K2 smartforms generated for lists. The rights required will vary depending on where the K2 for SharePoint app is installed from, either the SharePoint Store or the App Catalog.
    SharePoint Store
  2. K2 for SharePoint from the SharePoint Store requires Web.Manage user and app rights which corresponds to the default Designer permission level typically granted to site owner groups.  For more information see, Plan app permissions management in SharePoint 2013: http://technet.microsoft.com/en-us/library/jj219576(v=office.15).aspx
  3. All users must have at least Designer permissions to use any of the K2 for SharePoint functionality.
    App Catalog
  4. K2 for SharePoint from the App Catalog requires Site.FullControl user and app rights which corresponds to the default Full Control permission level typically granted to site collection administrators.  For more information see, Plan app permissions management in SharePoint 2013: http://technet.microsoft.com/en-us/library/jj219576(v=office.15).aspx
  5. All users must have at least Full Control permissions to use any of the K2 for SharePoint functionality.

K2 for SharePoint with support for the Common Consent Framework will allow for the separation of application and user rights removing the restriction for all users to have Designer or Full Control permissions while still allowing the K2 application to function correctly.

Note: The SharePoint Store does not allow apps to request Full Control permissions.  If you require Full Control for the K2 for SharePoint app read the following article KB001443 – How To: Deploy a Full Control K2 Application to SharePoint Online.

B. When deploying a SharePoint 2013 integrated workflow from K2 Studio or K2 Designer for Visual Studio that is configured to start manually, the K2 Service account must be granted start rights to the workflow. The same applies to workflows that are exported from the Workflow Designer (as*.kprx) in K2 for SharePoint, modified in the thick clients and redeployed, in this case the rights between thin client and thick client are not transferred in the export. No error is encountered if the rights are not granted, but the workflow will not be started.

C. The document Guidelines for installing K2 for SharePoint in existing K2 environments describes the various SharePoint environments that can function in a K2 environment and how you can move to K2 for SharePoint.

Installation

K2 for SharePoint is available as an independent installation package. Refer to the K2 for SharePoint documentation available for detailed installation instructions.

Prerequisites

Before installing K2 for SharePoint, ensure the following prerequisite software has been installed in your environment.

K2 Software Requirements
K2 for SharePoint is an add-on for K2 blackpearl and requires the following K2 software to be fully installed and configured.

 

SharePoint Requirements
  • SharePoint Server 2013 Standard Edition or SharePoint Server 2013 Enterprise Edition
Other Software Requirements
  • Microsoft Silverlight 4.0.50917.0 or higher (required by all client machines which will access the web-based K2 Workflow Designer)
  • .NET Framework 4.5
  • SharePoint Server 2013 Client Components SDK (required for distributed installations on machines that do not have SharePoint installed) 
Supported Browsers
SharePoint users/participants need a SharePoint-compatible Internet browser to view and use K2 for SharePoint features, including:
  • Internet Explorer 8 (runtime only), 9, or 10 (versions 6 and 7 are not supported)
  • Google Chrome (latest released version)
  • Mozilla Firefox (latest released version)
  • Apple Safari  is only supported on Mac (latest released version)

Installation Steps

Installing the K2 for SharePoint package needs to be performed in a specific order to ensure a successful and functional environment. Below are the steps that must be followed:
Step 1:Install K2 blackpearl 4.6.7 (4.12060.1590.0).
Step 2:
Install K2 smartforms 1.0.6 (4.12165.1625.0). If you do not have K2 smartforms, install it using a K2 smartforms runtime license which is available from https://portal.k2.com/licensekey/default.aspx.
Step 3:Install K2 smartforms Control Pack 1.0 (4.13180.1.0)
Step 4:
Install K2 for SharePoint 1.0 (4.13350.1.0)
Step 5:
Add the K2 for SharePoint App to your site
Step 6:
Register your K2 for SharePoint App
Step 7:
Create a SharePoint List or Library, click on the List/Library ribbon and select K2 Application.

Now you can create data, forms, workflows and reports in your SharePoint 2013 environment.

Upgrading from K2 for SharePoint RC

You can only upgrade your RC environment, upgrading prior Beta releases is not supported. All RC components must be upgraded as no combinations of RC and RTM will be supported.
    1. Important: Check in all Views and Forms in the System\SharePoint Integration category before starting the upgrade process. If this step is skipped the upgrade will fail and you will need to contact support for help.
    2. Upgrade all the RC componentsin the following order:
      Step 1: K2 blackpearl 4.6.7 RC (4.12060.0.0) Image K2 blackpearl 4.6.7 (4.12060.1590.0)
      Step 2: K2 smartforms 1.0.6 RC (4.12165.0.0) Image K2 smartforms 1.0.6 (4.12165.1625.0)
      Step 3: K2 smartforms Control Pack 1.0 RC (4.13180.0.0) Image K2 smartforms Control Pack 1.0 (4.13180.1.0)
      Step 4: K2 for SharePoint RC (4.13350.0.0) Image K2 for SharePoint 1.0 (4.13350.1.0)
    3. Upgrade the K2 for SharePoint App by completing the following steps:
    4. Note: To upgrade the K2 for SharePoint App you will require Site Member or above rights in SharePoint. The System Account cannot be used to upgrade the app.
      1. In SharePoint 2013 navigate to Site Contents.
      2. Navigate to the K2 for SharePoint App, hover over the App until the 3 ellipsis appear, click on the ellipsis.
      3. Select the ‘About’ option to be redirected to the Upgrade App Page (Note: It can take a number of hours after upgrading for the K2 App to reflect the upgrade status) . There are two versions of the App namely;
        • 4.4040.2.100 – Has Full Control rights and is available for on-premises and available for SharePoint Online via the App Catalog.
        • 4.4040.2.0 – Has Manage rights – and is available from the SharePoint Store.  This has a lower version so you can use the Update process to move from the store limited rights to the Full Control version by uploading to your App Catalog as described in the following Knowledge Base article: http://help.k2.com/KB001443.aspx
      4. A new Version of the App will be available, click on the Get It button.
      5. The Trust validation screen will appear, click on Trust It.
      6. The App will be upgraded.
    5. Run through the Registration wizard found on the K2 for SharePoint page under the General section. This will ensure that certain new features such as Managed SmartObjects can be accessed.
    6. Be sure to regenerate the SmartObjects on existing Lists and Libraries by selecting the Generate SmartObjects option under the New menu on the K2 Application page. Otherwise, the K2 Application page will display a message stating that the List or Library and the SmartObjects are out of sync even though no changes were made to it.  This message may take a while to display, depending on your environment. For more information, see the Generating SmartObjects from the K2 Application Page topic in the documentation.
    7. On the client machines from which the Worklist is accessed clear your browser cache to ensure the K2 Worklist App part returns existing items. In Internet Explorer you will need to clear the cache then close and open the browser again.
    8. Your upgrade is now complete and K2 for SharePoint is ready for use.
Known issues when upgrading:
  1. When clicking on the K2 App after upgrading from K2 for SharePoint RC to RTM the following error could occur “WIF10201: No valid key mapping found for securityToken: 'System.IdentityModel.Tokens.X509SecurityToken' and issuer: 'WindowsSTS'. Workaround:
    1. Clear your browser cache and restart the browser.
    2. When clearing your browser cache in Internet Explorer, make sure that the top checkbox is not selected and wait for Internet Explorer to give you confirmation that the cache has been cleared.
  2. When upgrading from K2 for SharePoint RC to RTM an environment that has a single HTTPS site with a host header that was used for both the K2 Designer and K2 Runtime sites, a duplicate environment field will be created. In some cases, there will be no default set for any of the fields of type Runtime. This will result in an error when the K2 App is clicked. The error message displayed is “The file '/Designer/Runtime/_trust/spauthorize.aspx' does not exist.”
    Workaround:
    1. Open K2 Workspace and browse to the Environment Library
    2. Locate the fields that are named SmartForms Designer Runtime 1. (Notice that there are duplicate fields with this name and no Default property set)
    3. Delete the field with value: [K2SITEURL]/Designer/Runtime
    4. Set the remaining field with value: [K2SITEURL]/Runtime/Runtime and set the Default column to True
    5. Browse back to the K2 for SharePoint App, and rerun the registration wizard.