Skip to main content

KB001745

DOWNLOADS

K2 SmartForms 4.7 RESOLVED ITEMS.PDF (210 KB)

K2 BLACKPEARL AND K2 FOR SHAREPOINT 4.7 RESOLVED ITEMS.PDF (203 KB)

PRODUCT: K2 blackpearl 4.7, K2 smartforms 4.7
 
LEGACY/ARCHIVED CONTENT
This article has been archived, and/or refers to legacy products, components or features. The content in this article is offered "as is" and will no longer be updated. Archived content is provided for reference purposes only. This content does not infer that the product, component or feature is supported, or that the product, component or feature will continue to function as described herein.

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.
 
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.

 
Installers

 

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 blackpearl
 
 

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.
K2 smartforms
 
  • 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, DepartmentHR. 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.
K2 Language Pack (Preview)
 
  • 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 blackpearl
 
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.
Be the first to reply!

Reply