Software Requirements and Prerequisites by component

This topic describes the minimum software requirements per K2 product and per product component/machine role in a K2 topology. For clarity, this topic is divided into Software Requirements by Component (components that are installed on servers in a K2 topology) and Software Requirements by Component (components that are installed on users' machines in a K2 topology).

For updated and additional information on integration and compatibility of K2 with other technologies, please refer to the Product Compatibility, Integration and Support Matrix.

  • IPv4 is required on all machines running K2 components (e.g. K2 Server, K2 websites, K2 client components). Although IPv6 can exist on these machines in addition to IPv4, IPv6 is not used by K2, therefore IPv4 is required. K2 will not operate as expected on environments where IPv6 is the only IP configuration
  • All machines running K2 components (for example, K2 Server and K2 websites) require TLS 1.2. Although TLS 1.3 can exist on these machines in addition to TLS 1.2, K2 does not use TLS 1.3.
    K2 will not operate as expected in environments where TLS 1.3 is the only configuration enabled.

Server Components

The table below lists the software/feature prerequisites or minimum requirements for server components (for example the K2 blackpearl Server and K2 sites components) in a K2 topology.

K2 product K2 Component Required/Optional Prerequisite / Requirement
K2 blackpearl K2 blackpearl Server
(K2 application server)
Required

Supported version of Microsoft Windows Server

Microsoft Message Queuing (MSMQ) Services with Directory Service Integration
User Manager
Read More...
The default User Manager is Active Directory (AD), but a custom user manager may be configured for use with K2 blackpearl.
Distributed Transaction Controller (DTC)
Supported version of Microsoft .NET Framework
Windows Identity Foundation Redistributable
Read More...
For more information, see http://support.microsoft.com/kb/974405.
Supported version of Windows PowerShell
Supported Browser

For the K2 server to send email, an SMTP server supporting:

  • Internet Simple Mail Transfer Protocal/Post Office Protocal 3 (SMTP/POP3)
  • Internet Message Access Protocal 4 (IMAP4)

Optional

Supported version of Oracle.
64-bit Oracle Data Access Components

Read More...

If the ODAC is not installed prior to registering a new service instance, an error is generated saying the assembly cannot be loaded because it is either not present or one of its dependencies is missing.
Download
Supported version of Dynamics CRM
Read More...
If you want to integrate with CRM 2013 or 2015, the K2 Setup Manager will automatically install the required SDK and redistributables.
Windows Support Tools
Read More...
Windows Support Tools is a prerequisite if the installer is to automatically set the SPNs during the installation of K2 blackpearl. For more information see http://go.microsoft.com/fwlink/?LinkId=62270

Microsoft Exchange

If Microsoft Exchange 2010 or Microsoft Exchange 2013 is being used, Windows Powershell 3.0 or later and WinRM (Windows Remote Management) are required, both of which are part of the Windows Management Framework:

https://www.microsoft.com/en-us/download/details.aspx?id=34595

For more information see Exchange Intergration Preperation

K2 blackpearl K2 database Required Supported version of Microsoft SQL Server
Distributed Transaction Coordinator (DTC).
Supported version of Microsoft .NET Framework
K2 blackpearl K2 for SharePoint (2013/2016) Required  Supported version of Microsoft SharePoint
(Integration with SharePoint Online or SharePoint 2013 and later requires the K2 for SharePoint component. )
There may be additional requirements before installing or using K2 for SharePoint for SharePoint Online or 2013 and later. See the Preparing SharePoint On-Premises topic.
See Preparing SharePoint On-Premises for more information on preparing your SharePoint environment.
Corresponding version of K2 blackpearl
Corresponding version of K2 smartforms
Supported version of Windows PowerShell
Supported browser
K2 blackpearl K2 for SharePoint (2010) Required

Supported version of Microsoft SharePoint 2010
Supported browser

SharePoint Foundation 2010 Client Side Object Model Redistributable for use with the SharePoint Content and SharePoint Management service brokers

Microsoft Report Viewer Redistributable 2008 SP1

The User Profile Service. For information see the section of the same name in the Preparing SharePoint On-Premises topic.

Microsoft Silverlight 4.0.50917.0 or higher is required by the web-based K2 Workflow design tool, as well as for rendering the K2 View Flow Report.
See the KB article: Known Issue: Silverlight does not load when using the Google Chrome browser for notes on compatibility between Silverlight and other web browsers.

K2 blackpearl K2 Workspace
(includes K2 web services and K2 Workspace web site)
Required Supported version of Microsoft Windows Server
Internet Information Services (IIS) 8
ASP.NET
Supported version of Microsoft .NET Framework
Windows Authentication Role Services
Supported version of Internet Explorer
Microsoft Silverlight 4.0.50917.0 or higher is required by the web-based K2 Workflow design tool, as well as for rendering the K2 View Flow Report.
See the KB article: Known Issue: Silverlight does not load when using the Google Chrome browser for notes on compatibility between Silverlight and other web browsers.
K2 blackpearl K2 for Reporting Services Required Supported version of Microsoft Windows Server
Internet Information Services (IIS)
ASP.NET
Windows Authentication Role Services
Microsoft SQL Server Reporting Services 2012
Microsoft .NET Framework 3.5 SP1 Redistributable Package
Download

Supported Browser

K2 smartforms K2 Designer Site Required Supported version of Microsoft Windows Server
Internet Information Services (IIS) 8
Supported version of Microsoft .NET Framework.
The Application Pool must run on .NET Framework v4.0.30319
The corresponding version of K2 blackpearl must be installed on a server that is reachable from this machine. For improved performance it is recommended to install the K2 Designer Site on the same physical machine as the K2 application server, see Performance Considerations.
K2 smartforms K2 smartforms Runtime Site Required Supported version of Microsoft Windows Server
Internet Information Services (IIS) 8
 Supported version of Microsoft .NET Framework.
The Application Pool must run on .NET Framework v4.0.30319
The corresponding version of K2 blackpearl must be installed on a server that is reachable from this machine. For improved performance it is recommended to install the K2 Runtime Site on the same physical machine as the K2 application server, see Performance Considerations.

Client Components

The table below lists the software/feature prerequisites or minimum requirements for client machines (for example the K2 client design tools, and end-user machines that access K2 artifacts) in a K2 topology.

K2 product K2 Component Required/Optional Prerequisite / Requirement
K2 blackpearl K2 for Visual Studio Required Supported version of Windows
Supported version of Microsoft Visual Studio
Supported version of Microsoft .NET Framework
K2 blackpearl K2 Studio Required Supported version of Windows
Supported version of Microsoft .NET Framework
K2 blackpearl

Machines that access K2 Reports

Machines that access K2 Worklist

Optional Microsoft Silverlight 4.0.50917.0 or higher is required by the web-based K2 Workflow design tool, as well as for rendering the K2 View Flow Report.
See the KB article: Known Issue: Silverlight does not load when using the Google Chrome browser for notes on compatibility between Silverlight and other web browsers.
K2 smartforms K2 smartforms Process Wizards Required

Corresponding version of K2 blackpearl client design tools (K2 for Visual Studio or K2 Studio). (This installs the SmartForms workflow wizards in the thick-client design tools, e.g. K2 Studio and K2 for Visual Studio).

K2 smartforms

Machines that access K2 Designer

Machines that access K2 SmartForms

Required Supported Browser (JavaScript must be enabled)
Optional Microsoft Silverlight 4.0.50917.0 or higher is required by the web-based K2 Workflow design tool, as well as for rendering the K2 View Flow Report.
See the KB article: Known Issue: Silverlight does not load when using the Google Chrome browser for notes on compatibility between Silverlight and other web browsers.