Install the K2 for Visual Studio component

Download: You can download an Excel Workbook to help you organize your K2 blackpearl installation by clicking here. Use this checklist to ensure that all topics have been read, understood and implemented successfully before, during and after K2 blackpearl installation. The checklist includes all possible items for both Standalone and Distributed installations. Please read the Reference Topic to determine if the item applies to your environment.

There is also a worksheet where users can record their configured settings as reference.

Prerequisites

K2 for Visual Studio

The K2 for Visual Studio component installs the K2 Designer for Visual Studio. This designer allows developers to use a tool they are familiar with (Visual Studio) to develop, design, and deploy K2 applications. The K2 for Visual Studio component requires the following prerequisites:

K2 blackpearl Prerequisites for the K2 for Visual Studio component
Operating System	* ** Microsoft Windows Server 2008 Standard, Enterprise SP2 or Microsoft Windows 2008 R2, RTM and SP1 or Windows Server 2012 Microsoft Windows Vista with SP1 or SP2 (Business or Ultimate) or Windows 7 with or without SP1 or Microsoft Windows 8 (Pro / Enterprise) or Microsoft Windows 10 (Pro / Enterprise) * Latest security patches ** See the topic 32-bit and 64-bit support in the Prerequisites - Hardware section.
Additional Software	Microsoft .NET Framework 4.5: For more information on .NET framework and K2, please see the topic: .NET Technologies Microsoft Visual Studio 2010-2015 (Professional / Premium / Ultimate) with or without Sp1 A User Manager: Active Directory Server (Windows 2000 Functional Level or greater). The default User Manager is Active Directory (AD), but a custom user manager may be configured for use with K2 blackpearl. Windows Powershell 3.0 or later (get it at the Microsoft Download Center.) Microsoft Dynamics CRM 4.0 SDK or Microsoft Dynamics CRM 2011/2013/2015 and CRM 2011/2013/2015 Redistributable (installed on the K2 Server) http://www.microsoft.com/downloads/en/details.aspx?FamilyID=82e632a7-faf9-41e0-8ec1-a2662aae9dfb&displaylang=en OpenXML SDK 2.0 Redistributable (required for Inline Functions) http://msdn.microsoft.com/en-us/office/bb265236.aspx Excel Web and Calculation Services with Trusted file locations for Excel spreadsheets or Microsoft SharePoint Server 2010 and Excel Services Application (only available in SharePoint 2010 Enterprise and MOSS 2007) with Trusted file locations for Excel spreadsheets

K2 blackpearl Prerequisites for the K2 for Visual Studio component

Operating System

* ** Microsoft Windows Server 2008 Standard, Enterprise SP2 or Microsoft Windows 2008 R2, RTM and SP1 or Windows Server 2012
Microsoft Windows Vista with SP1 or SP2 (Business or Ultimate) or Windows 7 with or without SP1 or Microsoft Windows 8 (Pro / Enterprise) or Microsoft Windows 10 (Pro / Enterprise)

* Latest security patches
** See the topic 32-bit and 64-bit support in the Prerequisites - Hardware section.

Additional Software

Microsoft .NET Framework 4.5:

For more information on .NET framework and K2, please see the topic: .NET Technologies

Microsoft Visual Studio 2010-2015 (Professional / Premium / Ultimate) with or without Sp1
A User Manager:

Active Directory Server (Windows 2000 Functional Level or greater).
The default User Manager is Active Directory (AD), but a custom user manager may be configured for use with K2 blackpearl.

Windows Powershell 3.0 or later (get it at the Microsoft Download Center.)
Microsoft Dynamics CRM 4.0 SDK or Microsoft Dynamics CRM 2011/2013/2015 and CRM 2011/2013/2015 Redistributable (installed on the K2 Server)

http://www.microsoft.com/downloads/en/details.aspx?FamilyID=82e632a7-faf9-41e0-8ec1-a2662aae9dfb&displaylang=en

OpenXML SDK 2.0 Redistributable (required for Inline Functions)
http://msdn.microsoft.com/en-us/office/bb265236.aspx
Excel Web and Calculation Services
with
Trusted file locations for Excel spreadsheets or Microsoft SharePoint Server 2010
and
Excel Services Application (only available in SharePoint 2010 Enterprise and MOSS 2007)
with
Trusted file locations for Excel spreadsheets

You can validate that you have the appropriate extensions installed by going into Visual Studio and selecting Help > About. You should see the following extensions listed:

Extensions for Windows WF

Install Steps

After you have installed all the prerequisites, you are now ready to install the K2 for Visual Studio component.

It is important to copy the installation files local to the server before installing. Do not install from a network share or UNC path. The installation will not work properly.

It is recommended to install this component on the client machine with an account with Local Administrator rights.

To install the K2 for Visual Studio component, follow the below steps:

From the local installation folder, double-click on the Setup.exe file

On the Welcome screen, click Next

On the End User License Agreement screen, read through the EULA. You must select the I agree option before you can continue with the installation. You can print out the EULA for your records. Once you have read the EULA, click Next

On the Installation Setup screen, select the Custom Installation option and type in a Installation Folder, and click Next

On the Select Components screen, you should see that the only components for which the prerequisites are met are:

K2 for Visual Studio,
K2 Documentation, and
K2 blackpearl Setup Manager

There may be additional components available depending on what is installed on your client machine. You will want to uncheck the box next to the other components.

Once you have verified the components, click Next

On the Client Components screen, you can select from the following options for the connection to an environment:

The environment refers to an Environment Library, which is used for storing all information about your various environments (such as server names, URLs, SharePoint Servers and sites) external to the process. This allows users to easily build the same process for any of the available environments configured without needing to rework the process by changing these common variables.

Connect to an existing environment. This allows you to select an existing HostServer Database to connect to. On the next page, you will see the HostServer Database screen, where you can connect to a database to use its configuration information.
Manually configure an environment. This allows you to type in a K2 Server name to connect to. On the next page, you will see the K2 blackpearl Server Configuration screen, where you can type in a Server Name and the ports.

On the Configuration Summary screen, validate the settings. You can go back to make any necessary changes, and you can print this page for reference later. Once you are satisfied with your settings, click Install.

The Setup Manager will update and show you the progress of the components as it installs.

When the installation has completed, you will see a finished screen. There will also be a link to the created configuration log file. When you click Finish, you will be prompted to restart now (click Yes) or restart later (click No). It is important to restart in order to complete the installation and configuration of K2 blackpearl.

Be sure to see the section on Post instillation common tasks once done with the install.