Understanding K2 Components
K2 environments contain a number of required and optional components that work together to enable the functionality provided by K2. On a high level. components can be divided into two main categories: server components and client components. Which components are installed, and where these components should be installed, will depend on your use of the K2 platform and the K2 topology you want to install.
This topic describes the purpose and use of the components in K2, as well as where the components are installed in typical K2 topologies. For clarity, this topic is divided into Understanding K2 Components (components that are installed on servers in a K2 topology, including the K2 database) and Understanding K2 Components (components that are installed on users' machines in a K2 topology).
Server Components
The table below lists the components that are typically installed on a server (for example the K2 blackpearl application Server, or web server hosting the K2 website-based components) in a K2 topology.
| K2 product | K2 Component | Required/ Optional |
Installed on | Description and Notes |
|---|---|---|---|---|
| K2 blackpearl | K2 blackpearl Server (K2 application server) |
Required | K2 Application Server(s) | The K2 blackpearl Server windows service and other components that provide the core functionality of the K2 platform, (for example, SmartObject service, Workflow services and SmartForms services, as well as supporting services including logging, authentication, scheduling, licensing, and others. |
| K2 database | Required | Microsoft SQL Instance | This is the database K2 uses for its own internal data storage. The database is usually installed along with the first installation of the K2 blackpearl Server, targeting a specified SQL instance. | |
|
K2 Workspace |
Required |
K2 Application Server(s) Web Server(s) |
This component includes the K2 web services (used by various tools to interact with K2) and the legacy K2 Workspace web site (used to administer a K2 environment) | |
| K2 Core | Required | All machines where K2 components are installed | Provides basic functionality required by the K2 installer, as well as installing assemblies required by K2. | |
| K2 Setup Manager | Required | All machines where K2 components are installed | The Setup Manager is used to install, remove, repair, and modify K2 components on the machine. | |
| K2 Package and Deployment | Optional (but recommended) |
K2 Application Server(s) | Used to package K2 artifacts (such as SmartObjects, Forms, Views and Workflows) in a K2 environment and then deploy the resulting package of artifacts in a different environment. | |
| K2 for SharePoint | Optional | App deployed to the SharePoint App Catalog | Provider-hosted app for SharePoint Online/2013 or later, allowing for building of applications with SmartObjects, SmartForms and Workflows in Microsoft SharePoint. | |
|
K2 for SharePoint 2010 K2 for SharePoint 2013 in 2010 mode |
Optional |
SharePoint 2010 WFE Servers SharePoint 2010 CA Servers |
Enables integration between K2 and SharePoint 2010 through features such as the K2 Worklist Web part and a Web-based workflow designer that is hosted within the SharePoint environment. | |
| K2 for Reporting Services | Optional | SSRS Server |
Reports can be created and rendered locally using the K2 Report Designer without SQL Reporting Services (SSRS). However, you can install K2 in a SSRS server for additional custom reporting capabilities, for example to expose SmartObjects as a data source for reporting through the K2 Data provider. The K2 for Reporting Services component can be installed on an existing SSRS environment. For more information on Reporting and an example of using the SQL Server Reporting Services Service Broker, see the topic Reporting in the K2 blackpearl User Guide. |
|
| K2 smartforms | K2 smartforms Runtime Site | Optional (but recommended) |
Web server(s) hosting the K2 smartforms Runtime site. K2 Application Servers |
Installs the website used by users to interact with SmartForms at runtime. Also used to run the K2 Management Site, which provides the administrative interface for K2. For improved performance it is recommended to install the K2 smartforms Runtime Site on the same physical machine as the K2 application server, see Performance Considerations. |
| K2 Designer Site | Optional |
Web server(s) hosting the K2 Designer site. K2 Application Servers |
Installs the website used by users to design SmartForms, SmartObjects and Workflows. 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 for SharePoint | Optional |
SharePoint 2010 WFE Servers |
Installs the wsp solutions required by K2 smartforms to the Web Front Ends. Only applicable for SharePoint 2010. | |
| K2 smartforms Setup Manager | Required | All machines where K2 smartforms components are installed | The Setup Manager is used to install, remove, repair, and modify K2 components on the machine. | |
| K2 Language Pack | K2 Language Pack | Optional |
K2 Application Server(s) Server(s) hosting the K2 smartforms Design Time site Server(s) hosting the K2 smartforms Runtime site |
Provides cultural adaptation and translation of non-configurable elements such as standard SmartForms Controls, the K2 View Flow report and elements of the K2 Designer in different languages. See the Compatibility Matrix for a listing of available languages. |
Client Components
The K2 client components refer to the various tools that users can use to design and build K2 applications and, to a lesser extent, interact with applications created with K2 (for example the K2 Mobile Applications).
| K2 product | K2 Component | Required/ Optional |
Installed on | Description and Notes |
|---|---|---|---|---|
| K2 blackpearl | K2 for Visual Studio | Optional | Developer Workstations | Includes the K2 for Visual Studio Core components and plug-ins, as well as specific installs for the supported versions of Microsoft Visual Studio installed on the workstation, allowing developers to build SmartObjects and Workflows with Microsoft Visual Studio and also perform additional tasks like debugging and repairing workflows. |
| K2 Studio | Optional |
Developer Workstations Designer workstations |
K2 Studio is a visual design environment which is targeted at more technical roles like SharePoint site owners, administrators and SharePoint developers, as well as Business Analysts and workflow developers. This design tool allows the user to assemble K2 workflows and create K2 SmartObjects. | |
| K2 Package and Deployment | Optional (but recommended) |
Developer Workstations Designer workstations |
Used to package K2 artifacts (such as SmartObjects, Forms, Views and Workflows) in a K2 environment and then deploy the resulting package of artifacts in a different environment. | |
| K2 Core | Required | All machines where K2 components are installed | Provides basic functionality required by the K2 installer, as well as installing assemblies required by K2. | |
| K2 Setup Manager | Required | All machines where K2 components are installed | The Setup Manager is used to install, remove, repair, and modify K2 components on the machine. | |
| K2 smartforms | K2 smartforms Process Wizards | Optional (but recommended) |
Developer Workstations Designer workstations |
Installs the SmartForms workflow wizards for K2 Studio and K2 for Visual Studio. |
| K2 smartforms Setup Manager | Required | All machines where K2 smartforms components are installed | The Setup Manager is used to install, remove, repair, and modify K2 components on the machine. | |
| K2 Mobile Applications | K2 Mobile Applications | Optional | Mobile Devices | n addition to the client tools listed above, you may want to install other client tools to allow users to interact with K2 applications. These are commonly referred to as the K2 Mobile applications and enable users to interact with their K2 tasks and applications built on K2. See the K2 Mobile Application page at https://help.nintex.com/en-US/k2mobile/userguide/legacy/default.htm for more information on these applications |