Introduction

K2 components have been updated with new and improved functionality and important bug fixes. The K2 4.7 release consists of the following updated components:
  • K2 blackpearl 4.7
  • K2 smartforms 4.7
  • K2 Language Pack 4.7 (Preview)
  • K2 connect 4.7
There are a number of changes in K2 4.7 that you need to be aware of prior to upgrading your existing environment. In certain instances you will be required to change settings, run consolidation tools or even upgrade 3rd party software. If you try to install K2 4.7 you may find that the installer will block you from continuing. Here is a summary of the changes you should be aware of:
  1. K2 4.7 requires a single database.
  2. Third-party support with the K2 4.7 release.
  3. K2 for SharePoint App Registration and Activation Management.
  4. Change in behavior in Role exclusion.
  5. The K2 for SharePoint 2013 installer has been merged with the K2 blackpearl installer. In these release notes any information relating to K2 for SharePoint will be grouped under K2 blackpearl.
  6. K2 smartforms Control Pack has been merged with SmartForms. In these release notes any information relating to K2 smartforms Control Pack will be grouped under K2 smartforms.
  7. The K2 smartforms server component install has been combined with the K2 blackpearl server component in the blackpearl installer. The SmartForms Setup Manager will install the Runtime and Design time sites as well as the SmartForms process wizards.
  8. To run the new K2 Management Site you will require the SmartForms runtime site. See the installation section for more details
Read the important considerations for more information.


Expand All
Close All

Which installer do I use?

The various K2 4.7 installers can be downloaded from the  K2 Partner and Customer Portal. Below details the installer options.

Important Considerations and Breaking Changes

If you are upgrading from a K2 version prior to 4.6.11 it would be advisable to read the important Considerations section of the K2 4.6.11 Release Notes. For K2 for SharePoint changes look under the K2 blackpearl drop down.

K2 Core

  • Legacy databasesIn order to upgrade to K2 4.7 you require a single database. If you have not yet consolidated your databases, you need to consolidate the databases prior to upgrading to 4.7. For more information, see KB001628 (http://help.k2.com/KB001628).
  • K2 Management Site: For the new K2 Management Site to run you must have the K2 smartforms runtime site installed. Run the SmartForms installer after the blackpearl installation if you require the runtime site.
  • License Audit Report: When Upgrading and opening the License Audit Report for the first time, all users will by default display with the last log in date as the date of the upgrade as this is the starting point after which it will update as users log in.
  • API: If you currently have made use of custom OAuthExtensions with logic in the Init method on the IHostableType interface in any K2 solutions, from K2 4.6.11 these solutions will no longer function as expected as the IHostableType has been removed. To fix the solutions you will need to change the related code and then recompile.
  • Unattended Installer: In order to implement new features, merge installers and resolve bugs new variables have been added to the installer. Any unattended files must be regenerated in this release to ensure that the full set of features and functionality gets installed.
  • .NET Framework: .NET Framework 4.6.1 is required from K2 4.7. If you have upgraded to .NET Framework 4.6 ensure that you read KB001712 (http://help.k2.com/kb001712) and downloaded the available update.
  • K2 for SharePoint 2013 requires as a minimum the SharePoint 2013 July 2016 Cumulative Update (CU).
  • When deploying a package that contained a large number of artifacts it would take a long time for the analysis to finish after each change if the Automatically re-analyze after each change checkbox was selected. By default this checkbox was selected when deploying a package. The default behavior has been changed and the Automatically re-analyze after each change checkbox is not selected when deploying a package. A blue Analysis Required icon will appear after changes are made in the deploy package, after which the Analyze button can be clicked. This allows you to make multiple changes in the package and then run the Analysis on the pakage once rather than after each change.
  • Workflow “Admin” rights have changed. You no longer need K2 Workflow Server “Admin” rights on the K2 environment to be able to manage workflow definitions and process instances. Users with Workflow Admin rights can now manage processes that they have “Admin” rights to, without needing K2 Workflow Server “Admin” rights as well.
  • The Workflow Management API behavior has changed. Methods that return lists were updated to return only the data that the currently-connected user has rights for. If the user does not have any rights, an exception is no longer thrown, but instead an empty list is returned. If you have code that relies on an exception to be thrown on these management methods, you will need to change your code accordingly to cater for the change in behavior.
  • The SmartBox data column length for encrypted data has changed from NVARCHAR(200) to NVARCHAR(MAX).
  • If you have built solutions or UI components for the SQLUM database take note of the following change that might impact your environment after upgrading to 4.7. When using a secure security key (AES_256), the resulting cipher data is bigger than the previous key and will required the password column in the CustomUM (SQL UM Provider) to be extended to store the new encrypted data.

K2 for SharePoint

  • K2 for SharePoint App: The K2 for SharePoint App no longer supports individual subsite control, from K2 4.7 the app is deployed per site collection and will be available on all subsites in the collection. For more information see KB001738.
  • K2 for SharePoint App: All users that use K2 in SharePoint (including list integration, creating, editing and deleting list items), require Read rights on the App Catalog.
  • K2 for SharePoint App: If you had integrated K2 with a SharePoint on-prem environment, and then integrated with SharePoint Online, you might not have an app catalog on your tenancy because the K2 app was available from the SharePoint Store. In K2 4.7 there are changes to the way in which the K2 app is registered and activated. You must create an app catalog site on the tenant (if one does not already exist) and add K2 for SharePoint to the app catalog site, where you then use the Registration Wizard to register the app with a K2 server. From that point forward, you must deploy and activate the app to site collections serviced by the app catalog using links on the Administration page.
  • Installer: The K2 for SharePoint installer has been merged into the blackpearl installer. Run the blackpearl, SmartForms installers and the Appdeployment.exe to install K2 in a SharePoint 2013 environment.
  • Microsoft is renaming "apps for SharePoint" to "SharePoint Add-ins” (for more information on this change implemented by Microsoft, please refer to  https://msdn.microsoft.com/en-us/library/office/fp161507.aspx and http://www.jeremythake.com/2015/06/office-365-app-model-rename-cheat-sheet/ ). K2 product documentation and some UI components of K2 may still use the term "App" as opposed to “Add-in”. Over time, K2 may be updating products, documentation, samples, and other resources to reflect the SharePoint platform name change from “App” to “Add-In”, but you can assume that the terms “App” and “Add-In” are synonymous.
  • Installer: The K2 smartforms server component install has been combined with the K2 blackpearl server component in the blackpearl installer. The SmartForms Setup Manager will install the Runtime and Design time sites as well as the SmartForms process wizards.
  • Unattended Installer: In order to implement new features, merged installers and resolve bugs new variables have been added to the installer. Any unattended files must be regenerated in this release to ensure that the full set of features and functionality gets installed.
  • Control Pack: The K2 smartforms Control Pack has been merged into SmartForms, this means that there is nolonger a separate Control Packer installer.
  • List View: Previously, you could select text in the List View with your mouse and copy the selected text. A change has been made to the copy and paste functionality that allows you to select a row or multiselect rows in a List View and then use CTRL+C to copy the rows, CTRL+V to paste. See keyboard shortcuts in the List View product documentation for more details.
  • Additional file types have been added by default to the Global Blacklist setting in the web.config file. This could result in certain files that your solutions previously allowed to be uploaded to be blocked. For more details on the Global blacklist see the File Attachment Control topic.
  • Custom Themes: K2 recommends that you actively maintain your custom themes by checking that they still render as expected after an upgrade. In order to implement new features, resolve bugs and improve performance, changes are made to the rendered HTML and accompanying CSS. As a result, custom themes will need to be adjusted to retain their existing appearance and behavior. In most cases, custom themes are copies of the core themes provided with SmartForms, with alterations to match the user’s requirements. It is recommended that the custom theme be compared with the theme on which it has been based using a tool such as Beyond Compare. From the comparison, structural changes will be evident and the required changes can then be made to the custom theme.
    The following changes were made in SmartForms 4.6.9 and up that need to be considered in order to ‘upgrade’ a purpose built custom theme:
                o Icons are no longer globally available, instead it is required that one specify the icons within the custom theme itself. This improves performance when a theme uses custom icons. Use the Platinum theme as an example.
                o The application of borders has changed on the following controls:
                        - Lookup Control
                        - Picker Control
                        - Date & Time Picker
                        - Dropdown List
                o The following controls have new stacked rendering implementations which can affect a custom theme:
                        - Radio button List
                        - Checkbox List
                        - Choice Control
  • Reporting Controls: Currently the On Change event in the rules would not execute when any of the reporting controls changed, but would rather execute when the controls were populated. The On Change event has been fixed in K2 4.6.11 to only execute when a selection is made. This would change the expected behavior that users are accustomed to and might require the Form rules to be adjusted accordingly.
  • System Objects: With the release of the new K2 Management Site the OAuth and Claims System Forms and Views in the K2 Designer are now hidden, this means that if you want to add or update an OAuth resource, for example, you will no longer find the Form in the System node in SmartForms. Browse to Start> All Programs>K2 blackpearl> K2 Management to open the site which contains the functions previously visible in the system Folder.
  • Changes applied to the Category naming structure – The category naming structure has been changed and will not allow a category name to include a backslash, for example, Department\HR. After upgrading to 4.7 all existing names containing backslashes will be updated and the backslash will be replaced with an underscore, making our example’s new name Department_HR. If for any reason after the upgrade the underscore results in a duplicate name the new category name will be incremented with an integer at the end, for example, Department_HR1. Note that a forward slash is still allowed in the category name.
  • The Language Pack only applies to K2 smartforms and K2 View Flow.
  • Runtime exception messages originating from the K2 blackpearl Server will still be displayed in English.
  • Localization support for the Design time is limited and areas of the Design time experience will still display in English after the K2 Language Pack has been installed.
  • If a multi-language Form is required, the Form and the Form Views must be designed in one language then copied and modified for each of the other languages you wish to support. Direct the user to the Form in the user’s language choice. During installation of the K2 Language Pack, select all the required languages to ensure that the required resource files are installed for the languages you wish to support.

What’s New in this Release?

There are several new features and enhancements available in this release. For K2 for SharePoint new features and enhancements look under the K2 blackpearl drop down.

K2 Core
Features Descriptions Documentation
Brokers REST Endpoint Broker: A dynamic endpoint broker with Swagger support for integrating with RESTful web services. Endpoints REST Service
Package and Deployment Package by Reference: Items can either be included directly or referenced when packaging. The referenced items must exist on the target, and the deploying user must resolve any missing references. Associations are preserved between direct or referenced items. Increased performance on comparisons. Creating a K2 Package
KB001705- SharePoint Application Lifecycle Management
KB001782 - K2 Package version Support Matrix
K2 Workspace The existing Management Console feature in K2 Workspace has been replaced with a new separate site which separates out the administrative tasks related to system admins. The existing Management Console in Workspace will still be available in K2 4.7 but you should use the new site in future. 
K2 Management Site: The new site provides management and administration functionality. The site retains a similar structure and feature list to the existing Management Console with a few additional features such as Workflow Scheduling. For the K2 Management Site to run you must have the K2 smartforms runtime site installed.
The new Management Site includes:
* License Management
* User Management
* String tables
* Environment Library
* Tree view site navigation
K2 Management Site
KB001769 - Comparison of capabilities between K2 Management Console and K2 Management Site
Worklist Out of Office Redirect Notification: The Out of Office (OOF) Notification allows all forwarded users to receive an email notification regarding delegated tasks when a specific user is out of office.
Out of Office Notifications
Enhancements Descriptions Documentation
Package and Deployment Performance enhancements were made to make packing solutions faster.
Package Analyzer: The Full Analysis and Partial Analysis options on the select package screen have been removed from MMC and the 'Automatically re-analyse after each change' option is no longer checked by default. This will improve the performance when deploying a package allowing the package to be analyzed once after all changes/missing references have been resolved.
Workflow Activity and Event System Names: The display name and system name of activities and events have been decoupled to improve the packaging and deploying of solutions. The change is reflected throughout the product where the system name would be seen. For example, reports, SmartForms rules, client event wizards and added columns in certain tables in the database. After upgrading any existing custom registered service instances and SmartObjects will require a service instance refresh and the SmartObjects updated for the new Activity Display Name property to be added.
Broker Docusign Service Broker: The Docusign service broker View object has been enhanced for embedded signing. Create embedded signatures with DocuSign
K2 Installation Microsoft SQL Azure: Clean installations of K2 can connect to a K2 database created on SQL Azure. Read the installation documentation for further details.
K2 for SharePoint Setup Manager: The K2 for SharePoint installer has been merged into the blackpearl installer. Run the blackpearl, SmartForms installers and the Appdeployment.exe to install K2 in a SharePoint 2013 environment.
K2 SmartForms Server component: The K2 smartforms server component install has been combined with the K2 blackpearl server component in the blackpearl installer. The SmartForms Setup Manager will install the Runtime and Design time sites as well as the SmartForms process wizards.
Installing the K2 database on Microsoft SQL Azure
Setting up the K2 database for SQL Azure
Workflow Rights Workflow “Admin” rights have changed. You no longer need K2 Workflow Server “Admin” rights on the K2 environment to be able to manage workflow definitions and process instances. Users with Workflow Admin rights can now manage processes that they have “Admin” rights to, without needing K2 Workflow Server “Admin” rights as well.
The Workflow Management API behavior has changed. Methods that return lists were updated to return only the data that the currently-connected user has rights for. If the user does not have any rights, an exception is no longer thrown, but instead an empty list is returned. If you have code that relies on an exception to be thrown on these management methods, you will need to change your code accordingly to cater for the change in behavior.
K2 for SharePoint
Features Descriptions Documentation
Forms Forms generations in SharePoint: Previously when a Form was used to action a worklist item and the Form was edited, if the save button was not clicked before submitting the action, the changes on the Form would not be saved. Now a Form will auto save when a worklist item is submitted and the Form contains changes.
Workflow Start Rule Condition:  Allows for workflows that are integrated with SharePoint Custom Lists and Document Libraries to start based on a specific condition that has been set within the Start Rule of the Workflow. Workflow Start Rule Options
Enhancements Descriptions Documentation
Workflow Activity and Event System Names: The display name and system name of activities and events have been decoupled to improve the packaging and deploying of solutions.
Worklist icon: An icon to the K2 Worklist has been added to the K2 section in the SharePoint ribbon.
K2 for SharePoint App Registration and Activation Management App Registration and Activation Management: Refer to the Knowledge Base article K2 for SharePoint Deployment and Activation (http://help.k2.com/kb001755) for more information on Deploying and Activating the K2 for SharePoint App. If you are currently using the K2 for SharePoint App in your SharePoint environment, please refer to the Knowledge Base article Upgrading K2 for SharePoint (http://help.k2.com/kb001738) for important considerations around upgrading the App. Note that All users that use K2 in SharePoint (including list integration, creating, editing and deleting list items), require Read rights on the App Catalog. App Registration and Activation Management
Lifecycle Management of SharePoint with K2 Integration
Software Support Descriptions Documentation
Microsoft Exchange Support for Microsoft Exchange Server 2016 has been added.
.NET Framework .NET Framework 4.6.1 is required in K2 4.7
SQL Server - Microsoft Azure SQL Server is supported.
- SQL Server 2016 is supported.
SharePoint SharePoint 2016 support is included in K2 4.7. Note, only the fields/lists/sites types supported in SharePoint 2013 will be supported for SharePoint 2016, any new types added in SharePoint 2016 will not be supported at this time.  Supported SharePoint Artifacts
Features Descriptions Documentation
Dependencies (ALM) Dependency Checks (also referred to as Application Lifecycle Management (ALM)) : Dependency checks help identify issues and dependencies on the View and Form level through visual indicators of changes (badging). Dependency check reports are useful for debugging changes/errors with Package and Deployment, giving notifications such as warnings when deleting objects with dependencies, and bug fixes that do not require architectural changes. The dependency checks will identify and address these issues in the K2 Designer, long before you attempt to package the Form. Fixing Dependency Issues
Workflow integration Workflow integration rules: A new set of rule events, conditions and actions have been added to SmartForms rule designer that allows the Form, View, subform or subview to interact with the workflow when it is submitted, started, opened or actioned. You are now also able to set the worklist item status when opened during the design phase of the workflow. Events
Conditions
Actions
Controls Barcode: The Barcode control allows you to capture barcodes in a SmartForm when using the K2 Mobile app (iOS version only). Barcode Control
Image Annotation: The Image Annotation control lets you take images with your mobile device (K2 mobile app iOS version only) , then mark and annotate the images. You can display the annotated image on a form or save it to a SmartObject for later use. Image Annotation Control
Enhancements Descriptions Documentation
Workflow Activity and Event System Names: The display name and system name of activities and events have been decoupled to improve the packaging and deploying of solutions. The change is reflected throughout the product where the system name would be seen. For example, reports, SmartForms rules, client event wizards and added columns in certain tables in the database. After upgrading any existing custom registered service instances and SmartObjects will require a service instance refresh and the SmartObjects updated for the new Activity Display Name property to be added. Integrating rules with workflow
Performance Runtime Performance: Various enhancements have been made to improve the SmartForms runtime experience.
Rule Actions SmartForms email: The smartforms email action now uses the same implementation as the notifications emails for workflow. Errors will now be logged in the hostserver logs and not in the K2 Designer as previously and anonymous access no longer needs to be set up on the exchange server to send mails via smartforms. Ensure that your K2 blackpearl email configuration is correct by having the correct SMTP / EWS configuration in the blackpearl installer and the correct Send As rights are configured in exchange for the From addresses that will be used.
Worklist Worklist Form: Previously when a Form was used to action a worklist item and the Form was edited, if the save button was not clicked before submitting the action, the changes on the Form would not be saved. Now a Form will auto save when a worklist item is submitted and the Form contains changes. SmartForms Task
API Custom Controls: Custom controls can now add files (css, images etc.) to a smartforms website, these files are defined in the control type definition as resources.
Installer K2 smartforms Control Pack Setup Manager:  K2 smartforms Control Pack has been merged into SmartForms, this means that there is no longer a separate Control Packer installer. Integrating rules with workflow
Controls Choice Control: The Stacked by property has been added to the choice control to indicate whether the items will be displayed in rows or columns at runtime. Choice Control
List Box Control: A new drop down property has been added to the List Box control called Selection Mode, which allows the Form designer to determine if the control can allow multiple or single seletions at runtime.
Rich Text Control :The control's Print property has been removed and rather included in the control's UI. At runtime when the print icon is clicked the page's print setup will open. Rich Text Control
Tree Control: Enhancements include keyboard accessibility, Search, N-Level loading, RTL support, and Async loading. Changes were made to the Tree control affecting the behavior of the control when installing K2 4.7. For more information see KB001754. Tree Control
Worklist Control: Changes have been made to allow for the sorting of the Status (availability) column of the Worklist control and to persist the control’s settings at runtime. Worklist Control
Auto Complete Control: Umlaut characters such as ü,ö,ä,ß for example can be used by the AutoComplete control.
Control Pack: The K2 smartforms Control Pack has been merged into SmartForms, this means that there is no longer a separate Control Packer installer.
Browsers The following browser versions are supported in K2 smartforms 4.7:
Internet Explorer 11.0.10240.17071 
Chrome 53.0.2785.101 m
Firefox 48.0.2
Version 9.1.2 (Windows support deprecated. Latest Safari version is only supported on Mac)
.NET Framework .NET Framework 4.6.1 is required in K2 4.7
Features Descriptions Documentation
Additional languages Two additional languages have been added to the Language Pack. The K2 Language Pack allows for the standard SmartForms controls as well as the K2 View Flow report and elements of the K2 Designer to display correctly in the following languages:
- Japanese
- Slovak
Enhancements Descriptions Documentation
Release Notes There are multiple bug fixes and an update to the SAP Netweaver RFC libraries KB000880 - K2 connect Release Notes

What’s been fixed in this Release?

K2 4.7 includes a number of bug fixes. Below is a list of the resolved issues by component. For K2 for SharePoint fixes look under the K2 blackpearl drop down.

Download the K2 Blackpearl and K2 for SharePoint 4.7 Resolved Items.PDF (203 KB) to view the list of fixes included in this release.

Download the K2 Smartforms 4.7 Resolved Items.PDF (210 KB) to view the list of fixes in this release.
An error is displayed at design time when the Tab Index property of a control is reduced to a value less than 1. The Tab Index property starts reducing automatically in a loop.
See the K2 connect release notes for more details on items fixed in this release. - KB000880 - K2 connect 4.7 Release Notes

What's been deprecated in this Release?

In the K2 4.7 release certain 3rd party software support, API methods and classes, and support for Windows services have been depricated, see below for further details. If you are currently using any of these depricated items you will need to make changes to either your environment or code to ensure that your K2 system is operational after upgrading.

  1. Support for the Microsoft Distributed Transaction Coordinator (MSDTC) service in the K2 SQL Server service has been dropped.
  2. Support for a number of versions of 3rd party software has been dropped, see the following article for the full list of unsupported software versions. For the latest support refer to the K2 blackpearl and K2 smartforms Product Compatibility, Integration and Support matrix.
  3. The K2 for SharePoint App no longer supports individual subsite control, from K2 4.7 the app is deployed per site collection. To add the app refer to the Add documentation or for upgrades see KB001738
  4. DataTable Getvoid SetSecurityUserName (String UserName, String SecurityLabelName)
  5. SecurityCredentialCache(Int32 rangeStart, Int32 rangeEnd, String filter, String orderBy)

Developer related/API changes

Various code changes have been made to improve K2 in this release. Some of these changes might affect existing custom code while other changes could be applied in your enviroment to introduce new or improved functionality. Below is a list of relevant changes.

  1. The following has been deprecated in SourceCode.SecurityManagementAPI, if you have written code against any of these items you will need to change your code to ensure it still functions as expected:
    • DataTable Getvoid SetSecurityUserName (String UserName, String SecurityLabelName)
    • SecurityCredentialCache(Int32 rangeStart, Int32 rangeEnd, String filter, String orderBy)
  2. In SourceCode.Security.OAuth.Management the GetHostServerConfigurationValue method now requires server admin rights. Existing custom code making use of this method will need to be updated accordingly. This change also affects the SharePoint App Deployment and as a result the K2WebService will require Server Admin rights.
  3. The MetaDataDoc endpoint has changed from http://[hostserver]:6332\api\metadatadocument to [K2URL]autodiscover\api\metadatadocument.
  4. When the GetLicenseKeyItem and SetLicenseKeyItem methods in the  SourceCode.LicenseManagementAPI are used the itemName string parameter will now be validated against the LicenseKeyColumn enumeration:
        LicenseText,
        LicenseData,
        LicenseKey,
        HostName,
        HostPort,
        MachineCode
     Using any other value for itemName will result in an ArgumentException being thrown.
  5. The SourceCode.Data namespace has been removed from the SourceCode.dll and moved into a separate server assembly named SourceCode.Data. This change will affect all projects referencing SourceCode.dll that use the SourceCode.Data namespace. Any custom built solutions using this namespace will need to be changed to reference the SourceCode.Data.dll located in the Host Server\Bin directory.
  6. The SmartBox data column length for encrypted data has changed from NVARCHAR(200) to NVARCHAR(MAX).
  7. If you have built solutions or UI components for the SQLUM database take note of the following change that might impact your environment and require you to make changes to your code after upgrading to 4.7. K2 changed the length of the column data type in the CustomUM (SQL UM Provider) database where the encrypted password is stored to accommodate the length of the new secure encrypted password.
  8. When a SmartForms custom control is registered using the Controlutil.exe K2 Server Admin rights are required.
  9. Workflow “Admin” rights have changed. You no longer need K2 Workflow Server “Admin” rights on the K2 environment to be able to manage workflow definitions and process instances. Users with Workflow Admin rights can now manage processes that they have “Admin” rights to, without needing K2 Workflow Server “Admin” rights as well. The Workflow Management API behavior has changed. Methods that return lists were updated to return only the data that the currently-connected user has rights for. If the user does not have any rights, an exception is no longer thrown, but instead an empty list is returned. If you have code that relies on an exception to be thrown on these management methods, you will need to change your code accordingly to cater for the change in behavior.

Known Issues

The following issues are currently known for K2 4.7 and include workarounds where possible. For K2 for SharePoint known issues look under the K2 blackpearl drop down.

K2 Core:

  • Issue: In K2 you are able to create a SharePoint List using custom List Templates that have been created in the K2 Workflow using the Create List wizard for example, however this functionality does not work as expected due to a limitation in Microsoft Client-Side Object Model (CSOM) which prevents the list from being created correctly.
    Workaround: There is no workaround at this time.
  • Issue: When creating an Azure SQL server instance pointing to an Azure database with the following settings "Use native execution" = True and "On a different server" = True, K2 creates a linked server in the local K2 Database but no default catalog is added to the linked server. However, Azure SQL Database isolates features from any dependency on the master database".
    Workaround: Delete the linked server and create it manually.
  • Issue: Unable to access the Azure master database and as such will not allow the creation of an Azure SQL Service instance from an Azure installation to another database with "Use Native Execution" set to true as linked servers are not supported on Azure.
    Workaround: Change “Use Native Execution” to false
  • Issue: Any Microsoft Distributed Transaction Coordinator (MSDTC) related connection from the SQL Server service will no longer function (as support for the MSDTC has been dropped).
    Workaround: Install the K2 4.7 May 2017 Cumulative Update and then use local stored procedures.

K2 for SharePoint:

  • Issue: When the lookup threshold limit of a SharePoint list or library is reached, a SharePoint error stating "This view cannot be displayed because the number of lookup and workflow status columns it contains exceeds the threshold enforced by the administrator" is displayed. Similarly, trying to integrate the list or library with K2 app will result in the error "GUID should contain 32 digits with 4 dashes."
    Workaround: Create a new SharePoint view for the list or library or switch to a view that contains less lookup items. This prevents the SharePoint error after which the K2 app integration functions as expected when clicking on the K2 icon in the SharePoint ribbon.
  • Issue: When Inherited permissions on a subsite are removed the K2 App will reset to use the Root Site Members and Owners permissions rather than the Unique Subsite’s permissions.
    Workaround:
    1. As the Site Administrator manually set the correct Permissions under the App Permission Link.
    2. Browse to the K2 for SharePoint Settings page and click the Sync Group link.
  • KB001783 - Known Issue: The workflow of a K2 for SharePoint List moves from the original list to the newly deployed list.
  • Issue: When clicking on a SharePoint 2013 list item to view the item details a blank page is displayed. This occurs when the Publishing features in SharePoint are enabled and you do not have the Browse Directory Site Permission.
    Workaround: Assign Browse Directory permission (on Site Collection level) for the users of the SharePoint list. Browse to the List and view the item details.
  • Issue: When using the K2 app to integrate with a SharePoint list or library containing a lookup column, and a generated form is used to start a K2 workflow, item references from associated or external data sources are marked with a red exclamation dependency. These are only visible on the specific external item references and not on the actions or rules where they reside.
    Workaround: When the red exclamation mark indicating a problem with the item reference is displayed, click Finish and then save and check in the form. At runtime the form behaves as it did before.
  • Issue: When changing a SmartObject list method in a list view, a red exclamation icon to show dependency issues is not shown on the rule,  however the action in the rule is badged to show the incomplete mappings and the Output tab is also badged.
    Workaround: Manually go into rules and look for icons on the action and the Output tab to ensure that the list method change has not broken any rules. 
  • Issue: When specifying the edit state of view controls on form level and you delete the control from the view, you can't create a K2 Package.
    Workaround: Edit the form and navigate to the rule specified. Open the Specify Edit State Action, Finish and save the form. Check in the form. You can create a K2 Package. 
  • Issue: In K2 you are able to configure a rule to action a worklist item and map any value from the context browser to the Serial Number and Action Name fields, however this functionality does not perform a validation on the values mapped at runtime and empty values could result in a server error and will disable the workflow strip.
    Workaround: Add an advanced condition before the action a worklist item action to ensure the values mapped are not empty (for both Serial Number and Action Name)
  • KB001784 - Known Issue: Only top Subview/Form is closed with synchronous rule.
  • KB001785 - Known Issue: Package and Deployment issue with view control and SmartObject mappings.
  • Issue: When a List/Get List method contains method bindings other than the default SmartObject properties, for example, SmartObject Method Parameters, Specific Value or System Value, the method bindings are not correctly returned in List control data sources and rules. In the image below a parameter was used in the Client SmartObject but the method binding was not mapped correctly.
    Workaround: Deselect the incorrect mapping (ID) and map the correct property to the parameter.
    Image
There are no known issues at this time

Installation

  1. K2 4.7 requires a single database prior to upgrading. If you have not yet consolidated your K2 databases see KB001628 for more information.
  2. K2 smartforms Control Pack has been merged into SmartForms, this means that there is nolonger a separate Control Packer installer.
  3. The K2 for SharePoint 2013 installer has been merged into blackpearl installer.
  4. To use the new K2 Management Site you must have the SmartForms Runtime Site installed even if you do not have a design-time license for SmartForms.

Refer to the Installation and Configuration guides available on help.k2.com for the prerequisites and steps needed to install the various components. Before installing any of the K2 components, ensure the correct prerequisite software has been installed in your environment.
When installing K2 4.7 using the full installation package the following install order is required.

  • K2 blackpearl 4.7
  • K2 smartforms 4.7
  • K2 Language Pack 4.7 (Preview)

See the K2 installation and configuration documentation for a full list of prerequisites. In this release the following prerequisites have been added or changed:

- .NET Framework 4.6.1.
- Single K2 Database
- SharePoint 2013 July 2016 Cumulative Update (CU)

The K2 Update Package makes it easier and quicker to update your environment by adding new files and only updating files that have changed. The K2 Update Package updates all the K2 components (blackpearl and smartforms) so you do not need to download and run multiple install files. Refer to the table in the Download section or to the compatibility matrix to see if your current K2 version can be upgraded to K2 4.7. The K2 Update Package automatically identifies what components are installed in your environment and will then update the components.

Note:  If you are on a K2 version prior to K2 4.6.9 you must use the K2 Installation Package to upgrade your environment.

Update Step:

  1. Run the K2 Update Package on each machine (e.g. servers, web servers and client machines) where K2 components are installed. The K2 Server must be updated first, then update all the other servers in the environment.
  2. If K2 for SharePoint 2010 or K2 for SharePoint 2013 in 2010 mode is being used, the K2 for SharePoint Configuration wizard needs to be run. The Finish Panel will display the link to launch the K2 for SharePoint Configuration Wizard.
  3. If K2 for SharePoint 2013 is installed the AppDeployment.exe will run directly after the K2 Update Manager has completed. For more information see the K2 Update Manager topic in the product documentation and read KB001738 on upgrading the K2 for SharePoint App .
  4. If you are a blackpearl only client download the K2 smartforms installer and install the K2 smartforms Runtime Site. This will allow you to use the new K2 Manangement Site
  • Upgrades:
    • K2 4.7 requires a single database, if you are still running the disparate (14) databases you will need to use the Database Consolidation Tool that was released for your version of the software to consolidate to a single database first. The 4.7 installer will block any upgrades on multi-Database installations.
    • If you are upgrading your K2 environment be sure to upgrade all the K2 components to the same version.
  • New prerequisite:
    • .NET 4.6.1 is required by the K2 Setup Manager.
    • The K2 Server (Host Server) requires .NET Framework 4.6.1 Ensure that you have .NET 4.6.1 installed on the server before upgrading or installing.
    • PowerShell 3 or higher is required by the K2 Setup Manager.
    • K2 for SharePoint 2013 requires SharePoint 2013 July Cumulative Update (CU)
    • For the new K2 Management Site to run you must have the K2 smartforms runtime site installed. Run the SmartForms installer after the blackpearl installation if you require the runtime site.
  • Installer change:
    • K2 smartforms Control Pack has been merged into SmartForms, this means that there is no longer a separate Control Packer installer.
    • The K2 smartforms server component install has been combined with the K2 blackpearl server component in the blackpearl installer. The SmartForms Setup Manager will install the Runtime and Design time sites as well as the SmartForms process wizards.
    • The K2 for SharePoint 2013 installer has been merged into blackpearl installer.
    • To use the new K2 Management Site you must have the SmartForms Runtime Site installed even if you are not a SmartForms customer.
  • Disable custom triggers on the tables in the K2 database. If Database Triggers have been added on the K2 Tables, which prevents the deletion or editing of these tables, when upgrading to K2 4.7 you will run into errors and the K2 Setup/Update Manager will not be able to override the triggers. It is recommended to disable the triggers first then run the K2 upgrade after which the triggers can be enabled again.
  • Run the K2 for SharePoint Configuration Wizard for SharePoint 2010. If you are upgrading from a version prior to K2 4.6.9 and you use K2 for SharePoint 2010, you will need to run through the K2 for SharePoint Configuration Wizard.
  • Run the AppDeployment.exe for SharePoint 2013. If K2 for SharePoint 2013 is being used, the K2 App will need to be re-deployed to the SharePoint App Catalog by running the Appdeployment.exe.
  • Deploy, register and activate the K2 App. With K2 4.7 there is a new way of updating the K2 App, the K2 for SharePoint App will need to be deployed to the App catalog, registered and activated for site collections, follow the steps in KB001738 to make the update. Once updated the K2 App should reflect the following version numbers:
    • K2 for SharePoint On-Premise - 4.4120.8.100
    • K2 for SharePoint Online - 4.4120.8.1
  • If your environment is using impersonation and Kerberos manual configuration is required when upgrading or setting up your environment. For more information see KB001607 – Delegation Settings to Allow Impersonation with Kerberos.
  • Refer to the Important Considerations section above before installing or upgrading.
  • Ensure that you have the correct permissions to run the install to avoid installation issues. For the correct installation permissions refer to the installation and setup guides.

Resolved Items in K2 4.7 Update version 4.16060.2000.1

  • After deleting a field on a view, the dependencies are flagged. Keeping those dependencies and trying to edit the view again, a JavaScript error occured.
  • After deleting a control on a form that is also used in a conditional style on the form, dependencies are flagged -- keeping those dependencies and editing the form resulted in an infinite spinner.
  • After upgrading to 4.7, mappings on a view were in error and the form upgrade script ran into errors stating "...Conversion failed when converting from a character string to unique identifier..."
  • After upgrading to 4.7, the view parameter gets a default value which is the parameter name.
  • Unable to upgrade to K2 4.7 when a workflow contains special characters as the upgrade script fails.
  • After upgrading to K2 4.7 the parameter's data type, for example Boolean, date or number, would be changed to Text.
  • When installing K2 4.7 on a clean environment, passwords containing a double hyphen (--) resulted in an error stating : " 13:8: ConfigFunctions.UpdateConfigComment: 09:31:07:>> Logged Error: Exception occurred while trying to update comments for file: ..."

Resolved Items in K2 4.7 Update version 4.16060.2000.2

  • Applying complex filters to CRM SmartObjects resulted in an object reference exception when the picker control tried to resolve a value.
  • When you have different worklist controls on a form, setting a filter on one worklist applied to all worklist controls at runtime and overrode the default filters for each control.
  • Deleting or changing AAD users were never disabled in identity cache.
  • Nested Organizational Units with the same name caused an ADUM error resulting in no AD details in identity cache for a given user, resulting in an error stating: "Error", "GetDirectoryEntry", "There is no such object on the server…."
  • Clicking on any tree node in the K2 Management site returned the following error, "SourceCode.Forms.Controls.Web.SDK.Utilities.SmartFormUnauthorizedAccessException…" Icons were also not loaded in the site.
  • Unable to export the license report as PDF in the K2 Management site as there is no option to do so.
  • Out of office in the K2 Management site defaults to K2 security label rather than the configured user manager.
  • When selecting any of the system SmartObjects in the K2 Management site the following error occurred : "The incoming request has too many parameters. The server supports a maximum of 2100 parameters. Reduce the number of parameters and resend the request."
  • Creating a K2 package took 25-30 minutes,  but no save screen was shown which allows you to download the package. The screen changed to a spinning icon on screen with no progress.
  • Deploying a K2 package created in MMC that contained a custom control that already existed on the environment  failed with the following error: "Cannot insert duplicate key row in object…"
  • When cancelling a deployment package because an error displayed for missing SmartObject and then regenerating the SmartObject resulted in the following error: "SmartObject Server Exception: Error refreshing Service Instance …"
  • When deploying a K2 package in which a view or form had a validation pattern of 'Numbers between 0 and 100 (Percentage)' resulted in errors stating that the pattern could not be found.
  • When trying to deploy a K2 package two SharePoint lists and a workflow, in which the workflow references both the lists, resulted in an error stating: "The following errors were encountered: Missing Reference: The 'K2 Event Receiver - item.Deleted'…"
  • The SmartForms runtime site contained an endpoint method that allowed all deployed objects in an environment to be accessed. 
  • After upgrading to K2 4.7, an error occurred when executing the action workflow rule, as the comments field at the activity level could not be found.
  • In certain K2 packages primary key constraints errors occurred on deployment.
  • When integrating a SharePoint library containing a content type or required number column with K2 for SharePoint, a 'Required Property Number does not exist on method. ' error occurred.
  • When your app catalog was created with a hosted name you were unable to click the Activate button on the Manage App Activations page and the following error was displayed "The site collection must be located in the same web application as the App Catalog."
  • When K2 Workspace and K2 Designer are running on separate URLs, the Activate button on the  Manage App Activation page did not function.
  • Registration wizard does not respond and the following error occurs “An existing connection was forcible closed by the remote host” or “Object reference not set to an instance of an object."
  • When selecting the "Allow user to action the task without opening the Form" setting the selection did not persist in the user task wizards.

Resolved Items in K2 4.7 Update version 4.16060.2000.3

  • KB001800 -Upgrading to K2 4.7 breaks the association between K2 workflows and SharePoint Lists and Libraries.