1 Prerequisites and Support - K2 Communitycommunity.k2.com/pfxaw45692/attachments/pfxaw45692... ·...

1 Prerequisites and Support

PrerequisitesThere are several hardware and software requirements regardless of the deployment scenario you choose. These aredetailed in the following sections:

Hardware Requirements

Software Requirements

Supported Browser for Designing SmartForms

Internet Explorer 8 (runtime only) and Internet Explorer 9 (runtime and design time)Internet Explorer on the desktop (IE10-desktop mode): Plug-in support is only available in Internet Explorer onthe desktop, and this version of Internet Explorer 10 must be used for items built on Silverlight, such as the K2Workflow Designer.Firefox 25.0.1Chrome 31.0.1650.57 mSafari 5.1.7

We always test on the latest release versions of Chrome, Firefox, and Safari. The versions listed are the currentversions at the release of K2 smartforms.

Unsupported

SQL Server 2000 and SQL Server 2005Installing K2 smartforms on K2 blackpoint 4.5 (any release) is unsupported.Silverlight is not supported when using the Chrome browser on a Mac operating system. This will result in issueswhen working in the K2 Workflow Designer which requires Silverlight. For more information on Silverlight andbrowser support see http://www.microsoft.com/getsilverlight/Get-Started/Install/Default.aspx .Silverlight is not supported when using the Safari browser on Windows operating system. This will result in issueswhen working in the K2 Workflow Designer which requires Silverlight. For more information on Silverlight andbrowser support see http://www.microsoft.com/getsilverlight/Get-Started/Install/Default.aspx .When not using Internet Explorer on the desktop, K2 features that require Silverlight, such as the K2 WorkflowDesigner, will not function in the browser. Switch to Internet Explorer on the desktop (IE10-desktop mode).

Authentication

When using Safari as the default K2 smartforms browser the IIS Authentication Provider settings must be set toNTLM only to ensure that the K2 smartforms features function correctly. For more information on Authentication seethe topic on Authentication.

Mobile Devices

Mobile Devices with Browser Support

While infrastructure changes are required by K2, each environment is different and has its peculiarities which must be taken into account.Modifying the infrastructure could have unforeseen results if the changes are not appropriately understood or managed. Given the broadspectrum of underlying infrastructure utilized, it is recommended that a panel or committee with appropriate skill in each area concerned beassembled to outline the underlying infrastructure changes and gauge the impact of the required changes.

K2 smartforms Installation and Configuration | 1

COPYRIGHT © 2008-2013. SOURCECODE TECHNOLOGY HOLDINGS, INC. SEE THE K2 smartforms Copyright andTrademark Statement

help file version 1.0.5(4.12165.1605.0)

http://www.microsoft.com/getsilverlight/Get-Started/Install/Default.aspx

http://www.microsoft.com/getsilverlight/Get-Started/Install/Default.aspx

1.1 Prerequisites Hardware

Hardware Requirements

Component Requirement

Hard Disk for Design Time Site 200mb (actual 132mb)

Hard Disk for Runtime Site 50mb (actual 12mb)

Hard Disk for SharePoint 10mb

Full K2 smartforms Installation 200mb (extracted and installed 1GB)




1.2 Prerequisites Software

Software RequirementsThe following software is required before installing K2 smartforms:

K2 blackpearl 4.6.6 or laterA supported browserMicrosoft SQL 2008 Express, Standard, Enterprise SP1 or SP2 or Microsoft SQL 2008 R2 RTM or SP1 or MicrosoftSQL 2012Internet Information Services (IIS) 7 or IIS 8 ( required for Design time and Runtime sites).Microsoft .NET Framework 4.5 (required for Design time and Runtime sites). Visit the following link to find outwhat .NET Framework version is currently installed:http://msdn.microsoft.com/en-us/library/hh925568.aspxWindows Identity Framework 3.5 (required for Claims based authentication): Runtime:http://www.microsoft.com/en-za/download/details.aspx?id=17331ORSDK:http://www.microsoft.com/en-za/download/details.aspx?id=4451The Application Pools must run on .NET Framework v4.0.30319

The following software is optional and is only required when using specific components of K2 smartforms:

Microsoft Silverlight 4 or 5 (required by the web-based K2 Workflow Designer)Optional - SharePoint 2010 Foundation, Standard or Enterprise RTM or SP1 or Microsoft Office SharePoint Server(MOSS) 2007 Standard, Enterprise SP2 is only required for SmartForms Web Parts and the SmartForms TaskWizard.Internet Explorer 9 or Internet Explorer 10 installed on the K2 server (required for rendering PDF documentswhen using the Save as PDF control. See the Save as PDF Control topic for supported scenarios)

For a breakdown per role see Design Time Prerequisites for the K2 Designers and Runtime Prerequisites for end users




http://msdn.microsoft.com/en-us/library/hh925568.aspx

http://www.microsoft.com/en-za/download/details.aspx?id=17331

1.2.1 Design Time Prerequisites for the K2 Designers

Design Time PrerequisitesTo use the K2 Designer environment, the following requirements are needed on the workstation:

1. Web Browser - Designers will require one of the following Web Browsers:Internet Explorer 9 or Internet Explorer 10 (Internet Explorer on the desktop (IE10-desktop mode): Plug-in support is only available in Internet Explorer on the desktop, and this version of Internet Explorer 10must be used for items built on Silverlight, such as the K2 Workflow Designer.)Firefox 25.0.1 Chrome 31.0.1650.57 m Safari 5.1.7

We always test on the latest release versions of Chrome, Firefox, and Safari. The versions listed are thecurrent versions at the release of K2 smartforms.

2. Microsoft Silverlight 4 or 5 (required for the K2 Workflow Designer). Minimum required version forSilverlight is 4.0.50917.0

3. OPTIONAL - SharePoint 2010 Foundation, Standard or Enterprise RTM or SP1 or Microsoft OfficeSharePoint Server (MOSS) 2007 Standard, Enterprise SP2 is only required if you are going to usethe SmartForms Web Parts and the SmartForms Task Wizard.

4. Microsoft .NET Framework 4.5 (required for Design time and Runtime sites). Visit the following link to find outwhat .NET Framework version is currently installed:http://msdn.microsoft.com/en-us/library/hh925568.aspx

5. Windows Identity Framework 3.5 (required for Claims based authentication): Runtime:http://www.microsoft.com/en-za/download/details.aspx?id=17331ORSDK:http://www.microsoft.com/en-za/download/details.aspx?id=4451

6. The Application Pool must run on .NET Framework v4.0.30319







1.2.2 Runtime Prerequisites for end users

Runtime Prerequisites for end usersTo use SmartForms at runtime, end users will require one of the following:

1. Web Browser on their workstation or mobile device:Internet Explorer 8, 9 or 10 Firefox 25.0.1Chrome 31.0.1650.57 m Safari 5.1.7

We always test on the latest release versions of Chrome, Firefox, and Safari. The versions listed are thecurrent versions at the release of K2 smartforms.

2. Microsoft Silverlight 4 or 5 (for the group of Silverlight controls such as the File upload control). Minimumrequired version for Silverlight is 4.0.50917.0.

3. OPTIONAL - SharePoint 2010 Foundation, Standard or Enterprise RTM or SP1 or Microsoft OfficeSharePoint Server (MOSS) 2007 Standard, Enterprise SP2 is only required if you are going to usethe SmartForms Web Parts and the SmartForms Task Wizard.

4. Microsoft .NET Framework 4.5 (required for Design time and Runtime sites). Visit the following link to find outwhat .NET Framework version is currently installed:http://msdn.microsoft.com/en-us/library/hh925568.aspx

5. Windows Identity Framework 3.5 (required for Claims based authentication): Runtime:http://www.microsoft.com/en-za/download/details.aspx?id=17331ORSDK:http://www.microsoft.com/en-za/download/details.aspx?id=4451The Application Pool must run on .NET Framework v4.0.30319.






2 Requirements for IIS 8 Settings

Requirements for Internet Information Services (IIS) 8 SettingsWhen using Internet Information Services (IIS) 8, the following settings need to be enabled before installing K2 smartforms:

.NET Extensibility 3.5

.NET Extensibility 4.5Application InitializationASP.NET 3.5ASP.NET 4.5Default DocumentHTTP ErrorsHTTP RedirectionStatic ContentDynamic Content CompressionStatic Content CompressionRequest FilteringURL AuthorizationWindows Authentication

To check if these are enabled, open the Server Manager from the Taskbar and select Manage > Add Roles and Features asshown below

Select Role-Based or feature-based Installation.




Select the correct Server from the Server Pool.




In the Server Roles section, select and expand Web Server.

Enable the required settings as mentioned above if not yet installed. Please note that the image below represents an environmentwhere all the required settings has not yet been installed.




3 Server Requirements

Server RequirementsK2 smartforms is an add-on to K2 blackpearl and all the server requirements are therefore the same as for K2blackpearl.Internet Explorer 9 or Internet Explorer 10 installed on the K2 server (required for rendering PDF documentswhen using the Save as PDF control. See the Save as PDF Control topic for supported scenarios)

For detailed information on the requirements, see the K2 blackpearl compatibility matrix




http://help.k2.com/en/blackpearlmatrix.aspx

4 Rights and Permissions

Rights and Permissions

Installation Rights

The Installation Account is the account which the person installing and configuring K2 logs on to the servers with.This account must be a domain account.

The permissions below are required during installation and configuration of K2 smartforms. After the installation iscomplete, you can revoke these permissions. However, you may need to add these permissions back whenreconfiguring your environment.

All Servers with K2 smartformsPermission Used For

LocalAdministrator

In order to successfully install and configure the K2 smartforms component, the InstallationUser account must be a local administrator on all the servers that will have K2 smartformsinstalled.

SQL ServerPermission Used For

dbcreator onthe SQL Server

For the K2 smartforms to be installed properly, the Setup User account needs dbcreatorpermissions on the SQL server.

securityadminon the SQLServer

For the K2 smartforms to be installed properly, the Setup User account needssecurityadmin permissions on the SQL server.

The K2 smartforms installation account requires sufficient database permissions on all existing K2 databases to be able to read/write andchange table structures.




5 Optional Trace Logging for Troubleshooting

Trace LoggingThe trace logging feature is available only for the K2 Installation manager and is intended to provide event logging for the installationprocess. The intended user base for this feature are K2 Support or Customer Infrastructure Administrators and Installers who wouldneed to troubleshoot any errors that they may encounter when installing a distributed environment.The Trace Logging feature is not part of the K2 Logging framework which is operational at run time, this feature is only operationalduring the installation process and only logs events relevant to the installation.

Operational ConsiderationsHow this worksHow to Enable or Disable Trace LoggingAccessing the Installer Trace Logs

Operational Considerations

The feature is enabled by default and can be disabled manually before the K2 Setup Manager is run. Owing to the load imposed bytrace logging, the performance of the installation will be affected when trace logging is enabled.

How this works

During the course of the installation, multiple threads are active and this results in a large volume of potential information beinggenerated by the logging service. The trace logging service will only log event items which are deemed necessary or which may beuseful for debugging.

The items or elements deemed useful for debugging are predetermined and there are no additional settings that can be configured.

How to Enable or Disable Trace logging

Trace Logging is disabled manually by amending the Product.config file and setting a flag as shown below.

To make the changes, browse to the folder where the K2 smartforms installer unpacked to and edit the Product.config file to makethe changes.

Figure 1: Example of extraction folder. Note the Product.config file is in the Installation folder.

1. Open the Product.config2. Set the following key to true or false to enable or disable trace logging respectively, then save the file




3. Start the Installer (Setup.exe)

The changes to the Product.config file must be made before the K2 Installer is started.

Setting Description

Simple Log = “false” No trace logging is run during the installation process.

Simple Log =”true” This is the default setting and when set to true, trace logging is enabled.

Accessing the Installer Trace Logs

Once the installation is complete, the Installer Trace log is available at "%temp%\k2 setup log" and named"InstallerTrace[date_iteration].log". If there are issues with the installation, the K2 Configuration Analysis tool would indicate thatthere are / may be issues that require resolving.




6 Setting up NLB

Setting up NLBIt is important to set up the Network Load Balancing (NLB) clusters before installing K2 blackpearl and K2 smartforms. It isalso important to test that the cluster is performing correctly prior to installing K2 blackpearl and K2 smartforms. Anincorrectly configured cluster can cause issues when using K2 blackpearl or K2 smartforms, and it adds a layer of complexityto troubleshooting.

The Network Load Balancing supported by K2 is:

Windows Network Load Balancing Manager

The following sections will describe how to configure the two supported types as recommended by K2.

Windows Network Load Balancing ManagerHardware Based load balancingTroubleshooting

Windows Network Load Balancing Manager

Configuring Network Load Balancing is an advanced task and should only be performed by an appropriately trained professional. The steps andconfigurations given in this help file are to be used as a guide - your system may require additional configuration due to different hardware and softwarecompatibilities.The 64-bit version of Network Load Balancing Manager (nlbmgr.exe) must be used for 64-bit Windows operating systems. For more information and to getthe 64-bit version of the Network Load Balancing Manager tool, please refer to the following Microsoft KB Article: http://support.microsoft.com/kb/892782

When configuring a cluster, follow the below steps:

Open Network Load Balancing Manager (nlbmgr.exe) (Start > All Programs > Administrative Tools >Network Load Balancing Manager, or Start > Run > nlbmgr.exe)

Add a New Cluster (right-click on Network Load Balancing Clusters and select New Cluster)

On the Connect screen, connect to the first host in the cluster and select the appropriate connection as theinterface. If the server has multiple network adapters, many interfaces may be displayed. Be sure to selectthe appropriate network adapter from the list, and click next

On the Host Parameters screen, select the host priority, add the host IP address and subnet mask, selectthe initial host stare then click next

the Cluster IP Addresses screen, add in any additional IP addresses that the cluster can be accessed from,and click next

In the Cluster Parameters window, enter the appropriate IP address, subnet mask, full internet name, andcluster operation mode, and click next

On the Port Rules screen, edit the existing rule to use the appropriate affinity. See the notes below forrecommendations based on the cluster type. Click next to continue

To add a second node to the cluster, right-click on the newly created cluster and select Add Host to Cluster

Connect to the second host, and make sure to select the appropriate interface

For a K2 Host Server cluster, use a Unicast operation mode and set the affinity to None. Since the K2 Host Server is a statelessmachine, no affinity is necessary per session.

For a K2 Workspace Server cluster, use a Unicast operation mode and set the affinity to Single. You will want to ensure that theweb pages retain an affinity to the web server during the session.

For a K2 smartforms Server cluster, use a Unicast operation mode and set the affinity to Single. You will want to ensure that theweb pages retain an affinity to the web server during the session.




http://support.microsoft.com/kb/892782

For a K2 for SharePoint Server cluster, use a Unicast operation mode and set the affinity to Single. You will want to ensure that theweb pages retain an affinity to the web server during the session.

The same is true for all server clusters that host web based components (such as Process Portals, web services, web parts).

In some cases, the Network Load Balancing Manager console will time out before the second node is configured. If that happens, just right-click on thecluster and select Refresh. You should see all the nodes in a Converged state. Make sure that your cluster is configured correctly before starting theinstallation.

As mentioned in the Installation and Configuration > Planning Guide > Additional Planning Considerations > Network Load Balancing Setup andConfiguration topic of the K2 blackpearl Getting Started documentation, at least two network adaptors are required when the Unicast operation mode isselected.

Set up the NLB configuration to allow traffic through on the K2 Workflow (default of 5252) and K2 Hostserver (default of 5555) ports.

If the SmartForms Design Time and Runtime Servers are installed on a different cluster to where the K2 installation is done, the Network Load Balancingsettings for the K2 smartforms Server Cluster will be exactly the same as for the K2 Workspace Server Cluster. In other words if there is a dedicatedSmartForms Cluster with IIS servers where all the K2 and SmartForms prerequisites have been met, the Network Load Balancing settings will be the sameas for the K2 Workspace Server Cluster in terms of the affinity setting and Port Rules.

Hardware based load balancing

Follow the hardware manufacturer's guidelines for configuring a load balanced host. Use the above notes for specifics on a K2Host Server Cluster, K2 Workspace Server Cluster or K2 smartforms Server Cluster.

While infrastructure changes are required by K2, each environment is different and has its peculiarities which must be taken into account. Modifying theinfrastructure could have unforeseen results if the changes are not appropriately understood or managed. Given the broad spectrum of underlyinginfrastructure utilized, it is recommended that a panel or committee with appropriate skill in each area concerned be assembled to outline the underlyinginfrastructure changes and gauge the impact of the required changes.

Troubleshooting

Problem:

Getting script errors when using a Network Load Balancer

Solution:

Ensure that all nodes in the Cluster or Farm have the same specified element in their web.config files. By default eachmachine/web site has its own machineKey that is autogenerated and used to encrypt information like the URLs ofWebResource.axd and ScriptResource.axd

Generate the machine keys using Internet Information Services Manager




Notice the d parameter in the querystrings below. You have to specify a machine key element to allow all the different nodesof a load balanced environment to encrypt and decrypt the information specified in the URL.




7 Design Time versus Runtime Sites

Design Time versus Runtime SitesIn SmartForms reference is made to Design Time and Runtime sites. It is important to understand what each of these termsrepresent and where they are found, set or configured within the product.

Design Time SiteRuntime SitesUnderstanding the SmartForms URL'sEditing the Environment Library Design Time and Runtime site settings

Design Time Site

Refers to the site that hosts the K2 Designer (used to build SmartObjects, Views and Forms) as well as the Workflow Designer. The Design Time site consists of two sites with the design time portion to host the designer and a runtime portion to host therunning/testing of built artifacts.

Figure 1

At installation the Design Time site is configured on the K2 Designer Web Site panel.

Image 1 - K2 smartforms Setup Manager K2 Designer Web Site Screen

Example URLs

The Design time site URL will resemble http://k2.denallix.com/Designer/The runtime portion of the Design time site URL will resemble http://k2.denallix.com:80/Designer/Runtime/




http://k2.denallix.com/Designer/

http://k2.denallix.com/Designer/Runtime/

Scenario 1

Note that the Design Time and Runtime sites can be one and the same site. This is achieved by checking the ‘Set as defaultruntime URL’ checkbox on the panel and would more than likely be used in a standalone or small scale environment.

Scenario 2

Where in a distributed environment it is possible to have multiple Design Time sites hosted on web servers that are part of a NLBset up. In this instance one of the Design time sites can be used as the runtime portion for all the other Design time sites.

Figure 2

Scenario 3

As the Design Time Site consists of the design element and then the runtime element it is possible to split these elements witheach one hosted on a different site. This means that the runtime element (URL) can be hosted with the Runtime site leaving onlythe design element(URL) to be hosted on the Design Time site. This is achieved by ensuring that the ‘Set as default runtime URL’checkbox on the K2 Designer Web Site panel is not checked and then rather checking the ‘Set as default runtime URL’ checkboxon the SmartForms Runtime Site.

Runtime Site

Refers to the site where users will view or interact with completed Forms.

Figure 3

At installation the Runtime site is configured on the SmartForms Runtime Site panel.




Image 2 Setup Manager SmartForms Runtime Site Screen

Example URL

The Runtime site URL will resemble http://k2.denallix.com:80/Runtime/Runtime

Scenario 1

In a standalone or small scale environment it is possible to have one site only that will host both the Design Time and Runtimesites. This is achieved by ensuring that the same site is selected in the K2 Designer Site and the SmartForms Runtime Site.

Scenario 2

When in a distributed environment it is possible to have multiple Runtime sites hosted on web servers that are part of a NLB setup. In this instance one of the Runtime sites can be used as the default Runtime site as in figure 4 where Web server C isinstalled with the SmartForms Runtime component ‘Set as default runtime URL ‘on the SmartForms Runtime Site checked.

Figure 4

Understanding the SmartForms URLs




http://k2.denallix.com/Runtime/Runtime

URL

The URL is built by code and is not stored anywhere. It is called the Vanity URL and represents the full actual URL. The first partis stored in the K2 Environment Library in K2 Studio or K2 Designer for Visual Studio as the default runtime URL The second partis built from an URL pattern and the View/Form’s name. An HTTP Module in the SmartForms web site checks all requests reachingthe Internet Information Services(IIS) Server for specific URL patterns. Checks for any URL containing “/View/{ViewName}/” or“/Form/{FormName}/” are performed and the module remaps the request to the actual URL.

http://K2DEV2SP:81/Runtime/Runtime/View.aspx?_name={ViewName}

http://K2DEV2SP:81/Runtime/Form.aspx?_name={FormName}

Protocol WebSite WebApplication WebPage QueryParameters

Custom URLs can be build that will automatically be remapped to the correct actual runtime URL.

For example:

The View name is “TaskList2”

If the following URLs are entered in the browser's address bar:

http://K2DEV2SP:81/Runtime/View/TaskList2/

http://K2DEV2SP:81/Runtime/Runtime/View/TaskList2/

http://K2DEV2SP:81/Runtime/R/A/N/D/O/M/View/TaskList2/

http://K2DEV2SP:81/Runtime/HR/Employee/OnboardingView/TaskList2/

They will all be mapped to the same URL:

http://K2DEV2SP:81/Runtime/Runtime/View.aspx?_name=TastList2

The part is fixed and can be changed in IIS and DNS

The part is the pattern matched by the HTTP Module

The part is the actual aspx page that services the request

The duplicate /Runtime/Runtime/ is not required, it can be edited in the K2 Environment Library in K2 Studio or K2 Designer forVisual Studio as shown below to have a single /Runtime/.

Fig.3 Environment Library




Fig.4 Changed URL

Forms support the following:

1. Vanity URL: http://dlx/SmartForms/Runtime/Form/test+form/2. By ID: http://dlx/SmartForms/Runtime/Form.aspx?id=b73caa60-ea6c-4948-a77e-18e05987a2ff3. By name: http://dlx/SmartForms/Runtime/Form.aspx?name=test form

Editing the Environment Library Design Time and Runtime sites settings

The environment Library Field types will be automatically added by the K2 Setup Manager. These can be changed in K2Workspace> Management Console> Environment Library > Field Types . Depending on the selection made duringinstallation with regards to the design time versus runtime, the system will determine the available entries to be modified. Belowis an example of what will be visible in Workspace for an environment where the design time and runtime sites are separate.

Image 3 - SmartForms Environment Field Types in K2 Workspace




To change the settings, select the Field type and click on Edit. Most of these settings must remain the same, however, the TypeName, Description Name and Added By Default fields can be changed.

Image 4 - Editing Field Types

The field types can also be set in K2 Process Portal. Browse to K2 Process Portal> Administration Settings> Environments.To change the field type settings click in the relevant field and make the change, then click OK to save the change.

Image 5 - SmartForms Environment Field Types in K2 Process Portal

The environment fields will appear in the Object Browser in K2 Studio and K2 Designer for Visual Studio as shown below:




Image 6 - SmartForms Environment Field in the K2 Object Browser

The fields can be edited by right - clicking on the node and selecting Edit Field.

Image 7 - Editing the SmartForms Environment Fields in K2 Studio




8 Installation

Installation

Path

K2 smartforms will install under %ProgramFiles%\K2 blackpearl\

URL

The root URL of SmartForms will be http:// {webserver}/designer by default unless modified during installation. Anexample of the URL would be http://k2.denallix.com/designer

Components

The following K2 smartforms components are installed during the installation process:

Component Description Where to install it

SmartForms Server Contains the SmartForms server andperipherals.

This component must beinstalled on the server where theK2 blackpearl server isconfigured to run or on aseparate SQL server.

K2 Designer The designer that allows for thecreation of SmartObjects, Views,Forms and Workflows.

This component can be installedon the same server as K2Workspace or on any IIS site.This allows for a distributedinstallation and the ability tosplit out your workspace webserver from your SmartFormsweb server. This componentrequires at least the K2blackpearl K2 Core component tobe on the server but any K2component will also do.

SmartForms Runtime Allows for the runtime site to beinstalled on a web server.

This component can be installedon the same server as K2Workspace or on any IIS site.This allows for a distributedinstallation and the ability tosplit out your Runtime site fromyour Design Time site byinstalling them on separateservers. This componentrequires at least the K2blackpearl K2 Core component tobe on the server but any K2component will also do.

SmartForms for SharePoint Install the wsp solutions required byK2 smartforms to the Web Front Ends.

This component must beinstalled on all the Web FrontEnd servers and requires the K2for SharePoint component to beon the system.

SmartForms Process Wizards These wizards surface in theK2 Designer for Visual Studio and K2Studio and allow Workflows to bestarted using SmartForms.

Install this component on theclient machines that have K2Studio and K2 Designer forVisual Studio installed.

K2 smartforms SetupManager

The Setup Manager allows for thefuture removal, repair, modification ofK2 smartforms.

This is a required componentand will be installed on all serverand client machines.

K2 smartforms can be installed either in a standalone or distributed environment. For more information on theseinstallations see the topics below:

StandaloneDistributedMaintenance




8.1 Standalone Install

Standalone InstallInstallation StepsPost Installation

Installing on a standalone environment will install all the K2 smartforms components on a single machine. Theprerequisite will be that all the K2 blackpearl 4.6.5 or greater components are also installed on this machine. Run theK2 Setup Manager .exe to install K2 smartforms.

Ensure that the K2 smartforms prerequisites and permissions have been configured prior to installation.

The flow diagram displayed below shows the different wizard screens that will be displayed, as well as the order inwhich they occur.




Installation stepsBefore the installation is started, the user must decide if the trace logging feature should be enabled. See the topicOptional installation logging for troubleshooting for more information.

When the installation is started, the Setup Manager will run through the following steps:

On the Welcome screen, click Next




The Setup Manager will check for the latest version of K2 smartforms.

The End User License Agreement needs to be read and agreed to before continuing.

Select the relevant components that should be installed - the default is all components. For astandalone installation leave all the components selected.

The K2 Server Database must then be configured. Make sure the database name is the name ofthe K2 blackpearl database.

On the License Configuration screen, the user must enter the license corresponding to the systemkey displayed. This can be obtained using the key request link on the screen.

On the K2 Designer Web Site screen, enter or select the web site details.

The next step is to configure the Designer Web Site Application Pool. The selected ApplicationPool account's Managed Pipeline mode must be set to Integrated.

On the next screen the SmartForms Runtime Site must be configured.

The next step is to configure the SmartForms Runtime Site Application Pool. The selectedApplication Pool account's Managed Pipeline mode must be set to Integrated.

The Configuration Summary screen will be shown and displays information regarding theinstallation. The details can be reviewed or printed.

Before the install begins, the Additional Actions screen is displayed if there are any actions thatneed to be performed such as an IISRESET.

The Installing screen displays the status of the installation as the installation occurs. If acomponent fails to install a red cross will display next to the failed component.

The Configuration Status screen shows the status of the configuration of individual components.

Once the components are installed and configured, the Configuration Analysis tool runs to verifysettings. The tool will display a warning or error icon If issues are discovered. These can be repairedby the tool it self by clicking Repair All.

The Finished page appears when the K2 Setup Manager is complete.

The Finished page of the Setup Manager provides the option of starting the SharePoint Configuration, see the topicK2 for SharePoint Configuration Manager for more information. The SharePoint Configuration manager must be runto deploy and activate the SmartForms solutions in SharePoint.

Post Intallation

If Internet Explorer is going to be the browser of choice then there are some post installation steps that mayapply to your environment, read the following topic for more information, Internet Explorer Settings.If K2 smartforms will be hosted in a SSL environment read the information in the Using K2 smartforms andSSL topic.




8.1.1 Setup Manager Welcome Screen

K2 Setup Manager Welcome screenWhat to do on this page

After you have installed the prerequisites, created the required accounts, you are ready to install the SmartFormsServer. The Welcome screen is the first screen that will display.

Fig.1 K2 smartforms Setup Manager Welcome Screen

What to do on this page

The steps below offer details on how to complete the page:

Click Next to proceed.




8.1.2 Setup Manager Check Latest Version

K2 smartforms Setup Manager Check Latest Version


An internet connection is required for this feature to be able to report accurately on the version that is currently being installed.

The K2 Installer, once the welcome screen has been displayed, will verify online whether the version being installedis the latest available. Although the latest major version may be that which is being installed, there may be anupdate which includes enhancements or fixes.

The version validation feature will provide assistance in three ways:

1. The version in use is correct with no further updates required2. The version in use has an update available which must be downloaded3. The utility is unable to determine if there is an update

Fig.1 K2 smartforms Setup Manager Latest Version screen showing no K2 smartforms installed

Checking for Latest Version

Current Installed Version The version of K2 smartforms currently installed

This Setup Manager Version The version of the installer currently being used to install K2 smartforms

Latest Version Available* The version of the installer which is available from the K2 Portal* The latest version can only be determined with the aid of an internet connection.


The steps below provide details on how to complete this page:




Wait for the page to report on the versioning

Take the necessary action as reported by the user page

Click Next to proceed




8.1.3 Setup Manager EULA

K2 Setup Manager EULAWhat to do on this page

The EULA describes the terms and conditions under which the K2 smartforms (in whole or in part) can be installed.The software can only be installed when the person / individual agrees to the terms and conditions as outlined in theEULA.

Fig.1 K2 smartforms Setup Manager EULA Screen

End User License Agreement

I agree to the terms andconditions of the license

The installer has the option to agree or not agree with the EULA. Theproduct can only be installed if the installer selects I agree.

Important: Selecting I agree and clicking Next is indicative of full agreement with the terms and conditions of the EULA. Selecting the option Iagree therefore binds the organization to comply with all terms and conditions as stated by the agreement.



Read and become familiar with the contents of the EULA

Select the option to I agree (Selecting this option legally binds the organization toterms and conditions)





OptionalStep

Click the Print button to print out the EULA




8.1.4 Setup Manager Select Components

K2 Setup Manager Select ComponentsWhat to do on this page

The Select Components screen enables the selection of either all or specific components available in K2 smartforms.Components that are not required can be disabled by removing the green check mark next to the component. Sinceeach component plays a vital role in the K2 environment, disabling components for a standalone installation willreduce functionality. However, when installing a distributed installation installing components on independentmachines enhances performance.

This page includes items that are required by default and cannot be removed from the components list. For example,the K2 smartforms Setup Manager is required to be installed with all K2 components.

Fig.1 K2 smartforms Setup Manager Select Components Screen

Select Components

Check box Checking the check box next to a component enables the item to be installedRemoving the check box excludes the component so that it is not installed

The SmartForms for SharePoint component places two wsp solution files on the machine, namely the web service and the SmartForms Viewer.For SmartForms to function it is necessary to deploy and activate the solutions, this is accomplished by running the K2 for SharePointConfiguration Wizard once the K2 smartforms Setup Manager has finished.



Select the desired components to install. For a standalone installation, all of thecomponents should be selected. The distributed installation guide will walk youthrough which components to install on which server role.




Click Next to proceed.




8.1.5 Setup Manager K2 Server Database

K2 Setup Manager K2 Server DatabaseWhat to do on this page

On the K2 Server Database screen, type in the name of the SQL Server where you installed the K2 Databases. Thispoints the SmartForms Server component to the K2 blackpearl Host Server database set up by the K2 Server, toshare configuration information. If you changed the Host Server database name, update it here and click Next.

Fig.1 K2 smartforms Setup Manager K2 Server Database Screen - Windows Authentication




Fig.2 K2 smartforms Setup Manager K2 Server Database Screen - SQL Authentication

Feature Description

SQLServer

Populate the name of the SQL Server where the SmartForms database will be installed.

Note: When a named instance has been used, provide that named instance here i.e.Sqlserver\Instance

Name The default name of the K2 Host Server Database is pre-populated here and can be altered.

Note: The default names are recommended for ease of identification.

What to do on this page:

The name of the Database server must populate the field labeled SQL Server (ornamed instance if a named instance has been used i.e. Sqlserver\Instance)

The Database Name example DLX will be populated automatically

Authentication:

The Form offers a choice in Authentication either Windows or SQL Authentication.

If Windows Authentication is selected the credentials of the K2 Service Accountwill be used to authenticate the connection to the SQL Server.

If SQL Authentication is selected, a connection string must be established toconnect to the SQL Server

For SQL Authentication Only:

1. Enter the User Name and Password

2. Click Test to verify the connection to the database




3. If the test passes, proceed to Step 4

4. If not, the User Name and Password must be corrected before the SetupManager will allow the installation to proceed

Click Next to continue




8.1.6 Setup Manager License Configuration

Setup Manager License ConfigurationWhat to do on this page

The License Configuration page displays when the K2 Designer (Design Time site) or SmartForms Runtime sites orboth are being installed. To proceed with the installation from this page a License key must be obtained for theregional support centre or by using the Key Request link provided on the License Configuration screen.

System Key The system key is generated at the time of installation and must be paired with a validlicense key for the installation to be successful.

License Key The License key is obtained directly from K2 Support. The URL provided on screen willenable the installer to request a license key.

What to do on this page:

To obtain a license:

Copy the System KeyClick on the URL provided on the License page (below the License Key field). This will direct you to the K2 site torequest your license key

To license your copy of the K2 smartforms platform:

If a license key is available, enter the license key

Click Next

If the license key is valid, the installation will proceed

If the license key is invalid, or a license key is not available the wizard will prevent the installationfrom proceeding




8.1.7 Setup Manager K2 Designer Web Site

K2 Setup Manager K2 Designer Web SiteWhat to do on this page

The K2 Designer Web Site Configuration establishes where the K2 Designer (Design time site) must be installed.

The K2 Designer Web Site Configuration screen enables:

1. The creation of the K2 Designer Site2. The ability to select an existing site if one exists

When selecting "Use an existing Web Site", this site must already exist.

Fig.1 K2 smartforms Setup Manager K2 Designer Web Site Screen

Feature Description

Create a New Web Site If you want to create a new site type the name in the Web Site Namefield, and K2 will create it automatically for you.

Use an Existing Web Site Name The name of the site that was created under IIS. If the name is left withthe default setting for example K2 then the K2 Designer (design time)URL will be similar to http:// K2/designer whereby K2 = the web servername.

Note: The site can be created without closing the K2 Setup Manager.Click Refresh to reload the list of available web site options.

Make this the primary runtimesite

Select the checkbox if this site is to be used as the primary runtimesite. For more information see the topic Design Time versus RuntimeSites.




If no site is listed in the Web Site drop down, one may need to be created. Type in the name of the web site you want to create, and K2 will dothe rest. If a site was recently created and does not display, you may need to perform an IIS reset. Then, click the Refresh button on this page.


To configure the K2 Designer Web Site:

Option 1- Create a new web site:

Enter the name for the New web site and K2 will create the URL


The Setup Manager will create the new Web site

Option 2 - Use an existing Web site

Select the web site to use from the Web Site drop down menu





8.1.8 Setup Manager K2 Designer Site - Application Pool

K2 Setup Manager K2 Designer Site - Application PoolWhat to do on this page

The K2 Designer Site Application Pool configuration screen enables you to select an existing, or create a new Application Pool for theSmartForms web service. If an Application Pool does not already exist or a custom one is required, a new Application Pool can be created.The selected Application Pool account's Managed Pipeline mode must be set to Integrated. If an Application Pool is selected and theManaged Pipeline is set to Classic mode a warning message will be displayed to inform the user that K2 will change the mode toIntegrated. However, if other applications are dependent on the same Application Pool K2 will not change the mode but will rather informthe user that a new Application Pool needs to be created. The SmartForms’ Application Pool also needs to run on the .NET Frameworkv4.0.30319. If you have an existing SmartForms Application Pool running on the .NET Framework v2.0.50727 and this application pool isused for other applications as well, a new application pool is required for K2 smartforms 1.0.4. If you have an existing application poolrunning on the .NET Framework v2.0.50727 that is only used for K2 smartforms, this application pool needs to be configured to run on the.NET Framework v4.0.30319.

Fig.1 K2 smartforms Setup Manager K2 Designer Site - Application Pool Screen

Feature Description

Use an existing Application Pool Select this option if an existing Application Pool should be used.

Application Pool The name of the site that was created under IIS.

Update or Create a new Application Pool If you want to create a new Application Pool, type the name in the Application PoolName field, and K2 will create it automatically for you.

Application Pool Enter the name of the Application Pool; a custom name can be entered or use theexisting, Default AppPool

User Name The fully qualified domain user account under which the Application Pool hostingthe site is run.

Password The password for the Service Account.

If no application pool is listed in the Application Pool drop down, one may need to be created. Type in the name of the Application Pool you want to create, and K2 will dothe rest. If an account was recently created and does not display, you may need to perform an IIS reset. Then, click the Refresh button on this screen. If you create theApplication Pool manually ensure the Managed Pipeline is set to Integrated and uses the .NET Framework 4.5


To configure the Application Pool with an Integrated Managed Pipeline mode:

Select to use an existing Application Pool, or to create a new one

If the Existing Application Pool option was selected, go to the Next step or




If you selected to create a new Application Pool proceed1. Enter a name for the new application pool, or use the default2. Provide a User account that is preferably the same user account as the K2 Server serviceaccount

3. Enter the password for the User Account provided

When prompted with the warning, click Yes.

Important: Workspace Application Pool, Central Administration Application Pool, K2 Designer Application Pool and SmartForms Runtime Application Pool account and the K2Service Account User(s) need to be added to the System Administrators group in CRM to prevent a “401” Unauthorized error. These rights are required as the CRM URLs arequeried directly from SharePoint and not only via K2HostServer.




8.1.9 Setup Manager SmartForms Runtime Site

K2 Setup Manager SmartForms Runtime SiteWhat to do on this page

The SmartForms Runtime Site configuration screen establishes where the Runtime site must be installed. This can bethe same site as the K2 Designer site (design time) or it can be a separate site.

The SmartForms Runtime Site configuration screen enables:

1. The creation of the SmartForms Runtime Site2. The ability to select an existing site if one exists

When selecting "Use an existing Web Site", this site must already exist.

Fig.1 Setup Manager SmartForms Runtime Site Screen

Feature Description

Create a New Web Site If you want to create a new site type the name in the Web Site Namefield, and K2 will create it automatically for you.

Use an Existing Web Site Name The name of the site that was created under IIS.

Note: The site can be created without closing the K2 Setup Manager.Click Refresh to reload the list of available web site options.

Make this the primary runtimesite

Select the checkbox if this site is to be used as the primary runtimesite. For more information see the topic Design Time versus RuntimeSites.

If no site is listed in the Web Site drop down, one may need to be created. Type in the name of the web site you want to create, and K2 will dothe rest. If a site was recently created and does not display, you may need to perform an IIS reset. Then, click the Refresh button on this Form.





To configure the SmartForms Runtime Site:

Option 1- Create a new web site:

Enter the name for the New web site and K2 will create the URL


The Setup Manager will create the new Web site

Option 2 - Use an existing Web site

Select the web site to use from the Web Site drop down menu





8.1.10 Setup Manager SmartForms Runtime Site - Application Pool

K2 Setup Manager SmartForms Runtime Site - Application PoolWhat to do on this page

The SmartForms Runtime Site Application Pool screen enables you to create a new Application Pool for the SmartForms web service. Ifan Application Pool does not already exist or a custom one is required, a new Application Pool can be created . The selected ApplicationPool account's Managed Pipeline mode must be set to Integrated. If a Application Pool is selected and the Managed Pipeline is set to Classicmode a warning message will be displayed to inform the user that K2 will change the mode to Integrated. However, if other applicationsare dependent on the same Application Pool K2 will not change the mode but will rather inform the user that a new Application Pool needsto be created. The SmartForms’ Application Pool also needs to run on the .NET Framework v4.0.30319. If you have an existing SmartFormsApplication Pool running on the .NET Framework v2.0.50727 and this application pool is used for other applications as well, a newapplication pool is required for K2 smartforms 1.0.4. If you have an existing application pool running on the .NET Framework v2.0.50727that is only used for K2 smartforms, this application pool needs to be configured to run on the .NET Framework v4.0.30319.

Fig.1 SmartForms Runtime Site Application Pool Screen

Feature Description

Use an existing Application Pool Select this option if an existing Application Pool should be used.

Application Pool The name of the site that was created under IIS.

Update or Create a new Application Pool If you want to create a new application pool, type the name in the Application PoolName field, and K2 will create it automatically for you.

Application Pool Enter the name of the Application Pool; a custom name can be entered or use theexisting, Default AppPool

User Name The fully qualified domain user account under which the Application Pool hostingthe site is run.

Password The password for the Service Account.

If no application pool is listed in the Application Pool drop down, one may need to be created. Type in the name of the application pool you want to create, and K2 will do therest. If an account was recently created and does not display, you may need to perform an IIS reset. Then, click the Refresh button on this Form. If you create theapplication pool manually ensure the Managed Pipeline is set to Integrated.


To configure the Application Pool with an Integrated Managed Pipeline mode:

Select to use an existing Application Pool, or to create a new one

If the Existing Application Pool option was selected, go to the Next step or




If you selected to create a new Application Pool proceed1. Enter a name for the new application pool, or use the default2. Provide a User account that is preferably the same user account as the K2 Server serviceaccount

3. Enter the password for the User Account provided

When prompted with the warning, click Yes

Important: Workspace Application Pool, Central Administration Application Pool, K2 Designer Application Pool and SmartForms Runtime Application Pool account and the K2Service Account User(s) need to be added to the System Administrators group in CRM to prevent a “401” Unauthorized error. These rights are required as the CRM URLs arequeried directly from SharePoint and not only via K2HostServer.




8.1.11 Setup Manager Configuration Summary

K2 Setup Manager Configuration SummaryOnce the Setup Manager starts the installation, the process CANNOT be stopped.


The Configuration Summary screen displays the details captured in the Setup Manager Wizard. Information containedin this summary should be scrutinized for accuracy.

Fig.1 K2 smartforms Setup Manager Configuration Summary Screen

Feature Description

Print Allows you to print your configuration settings. This can be a useful record of theconfiguration details.

Copy Allows you to copy the contents of the screen to your clipboard. This can be auseful record of the configuration details.

Back Navigate in reverse order through the wizard to make changes

Next Continues the installation by opening the additional actions page

Cancel Cancel the current installation session


To make changes:

Click Back to navigate in reverse order through the Setup Wizard pages to locatethe page that requires an update




Make the change

Click the Next button until the Configuration Summary page is displayed again

Click Install to proceed

To Install:

Review the summary details to make sure the captured information is accurate

Click Next to start the installation process




8.1.12 Setup Manager Additional Actions

K2 Setup Manager Additional ActionsWhat to do on this page

The Additional Actions screen displays the additional, required actions that needs to be performed, by clicking Nextthese actions will be performed by the K2 smartforms Setup Manager before starting the installation process.

If the user clicks ‘Next’ then all listed actions will be done by the Setup Manager. Alternatively the user may elect to perform some of theseactions manually at this point, and then click on ‘Refresh’ in which case the list will be refreshed to only contain the actions that are stillrequired.

Fig.1 K2 smartforms Setup Manager Additional Actions Screen

Feature Description

Refresh Click 'Refresh' to ensure manual actions have been completed

Back Navigate in reverse order through the wizard pages to make changes

Next Click 'Next' to proceed with the installation. Once this option is selected all thelisted actions will be performed by the Setup Manager.Note: The installation cannot be stopped after this button is clicked.

Cancel Cancel the current installation session


To make changes:

Click Back to navigate in reverse order through the Setup Wizard screen to locatethe screen that requires an update




Make the change

Click the Next button until the Additional Actions screen is displayed again

To Install:

Review the Additional Actions details list

Click Next to start the installation process. Note: All listed actions will be done bythe Setup Manager after clicking on the 'Next' button




8.1.13 Setup Manager Installing

K2 Setup Manager InstallingWhat to do on this pageInstallation Troubleshooting

The Installing screen displays the status of the installation, with a progress bar for each component as well as anoverall progress bar. The component progress bar indicates the progress of the individual component, whereas theTotal Progress Indicator reports on the installation progress as a whole.

Fig.1 K2 smartforms Setup Manager Installing Screen


There is nothing to do on this screen but to wait for the installation to complete.

Important: It is strongly advised that the installation is not interrupted for any reason. Interrupting the installation will cause file corruption andunpredictable results in your environment.

Installation Troubleshooting

If a component fails to install correctly a red X will be displayed next to the component name. A warning messagewill display on the Finish screen stating that a component failed to install correctly. Investigate why the componentfailed to install by viewing the install logs.




8.1.14 Setup Manager Configuration Status

Setup Manager Configuration StatusThe Configuration Status screen shows the current status concerning the configuration of components being installed.

A progress bar for each component as well as an overall progress bar is shown. The Component Progress barindicates the progress of the individual component, whereas the Total Progress bar indicates the configurationprogress as a whole.

Fig.1 K2 smartforms Setup Manager Configuration Status Screen

There is nothing to do on this page, simply wait for the components to be configured. Once everything is done, theConfiguration Analysis form will be displayed if applicable.




8.1.15 Setup Manager Configuration Analysis

Setup Manager Configuration AnalysisThe Configuration Analysis tool shown below is used to analyze an installation. Items with errors are flagged by a redX, indicating that this item has not been configured correctly and requires repair. Items that have been installed andconfigured correctly are indicated by the green validation mark while items with warnings are indicated with theyellow exclamation mark. In all cases more information is supplied in the right-hand pane.

Fig.1: Configuration Analysis tool

Item Description How to use it

AnalyzeAll

Starts theautomaticanalysis of aninstallation

If the Analysis tool is being run for the first time, or if verification is required thatchanges have repaired errors, click the Analyze All button to analyze yourinstallation.

Analyze Starts theanalysis of theselectedbranch

If verification is required that a change has repaired an error, select the relevantbranch and click the Analyze button to analyze your installation. Please notethat the Analyze button is only available for child nodes.

Repair Repairs theselected item

Select a specific item that has an error and then click Repair to attempt a repairon the item.

RepairAll

Repairs allitems wherethere is anerror

No individual items need be selected. Clicking on the Repair All optionautomatically tries to repair all items in Error or in Warning state starting at thetop and working down the list.

Export Exports theerror report

The information reported by the Configuration Analysis tool can be exported to atext file. The file will be in plain formatting and contain a printer friendly and e-mail friendly version of the information displayed graphically by the tool.

Icons




Information This shows information relating to the node indicated.

No Errors This icon is used for the parent node or for a node item that has no errors and isinstalled and configured correctly.

AttentionRequired

This icon appears only at a parent node, when an error has been detected on asub item.

Errors The item with an error is indicated with the White X on red icon.

Warnings The item with a warning is indicated with an exclamation mark icon.

User Page Controls for the tool running in the Setup Manager

Opens help Opens the help system to the Configuration Analysis tool section.

Back Stepsbackwards

During Setup, indexes to the previous setup step.

Next Stepsforwards

During Setup, indexes to the following setup step.

Cancel CancelsSetup

Cancels installation and closes down the setup manager.

User Page Controls for the tool running from the Start menu

Close Closes thepage

Click the Close button to close and exit the analysis tool

For a summary of checks performed by the Configuration Analysis Tool see the topic Summary of Tool Checks.




8.1.15.1 Summary of Tool Checks

Summary of Tool Checks The following check is performed on a new K2 smartforms installation.

New K2 Designer site created by the installer

Created with the following settings:

Windows Authentication: TrueAnonymous Authentication: True (The K2 Designer virtual directory is set to true, but the parentsite remains what it was at the time of upgrading and set to false if the installer creates it )Forms Authentication: False (This setting is set to True in Non-AD installations) Use Kernel Mode Authentication: TrueUse Application Pool Credentials: True

New K2 Designer Application pool created by the installer


Classic Pipeline modeApplication Pool user added to the “IIS_IUSERS” group

New SmartForms Runtime site created by the installer


Windows Authentication: TrueAnonymous Authentication: True (The K2 Designer virtual directory is set to true, but the parentsite remains what it was at the time of upgrading and set to false if the installer creates it )Forms Authentication:False (This setting is set to True in Non-AD installations)Use Kernel Mode Authentication: TrueUse Application Pool Credentials: True

New SmartForms Runtime application pool created by the installer


Classic Pipeline modeApplication Pool user added to the “IIS_IUSERS” group




8.1.16 Setup Manager Finish

K2 Setup Manager FinishIf any errors were encountered before the configuration phase of the installation was complete, then the K2 Configuration Analysis tool will runbefore the installation completes.

K2 Setup Manager - Setup Manager Finished


This Finished screen appears when the K2 Setup Manager is complete. There will be a link to the log file that wascreated. This log file can be helpful when troubleshooting issues in the K2 Environment. The next part of theinstallation is configuring SharePoint to use K2. The K2 for SharePoint configuration Wizard can be openedautomatically by the Setup Manager provided the check box is selected. If the check box is not selected the K2 forSharePoint Configuration wizard must be initiated manually from the icon in the K2 blackpearl folder of the StartMenu in order to complete the installation.

Fig.1 K2 smartforms Setup Manager Finish Screen

The SmartForms for SharePoint component places two wsp solution files on the machine, namely the web service and the SmartForms Viewer.For K2 smartforms to function it is necessary to deploy and activate the solutions, this is accomplished by running the K2 for SharePointConfiguration Wizard once the K2 smartforms Setup Manager has finished.


The K2 Setup Manager is complete. Clicking Finish will finalize the installation process.




8.1.17 K2 for SharePoint Configuration Manager

K2 for SharePoint ConfigurationThe K2 for SharePoint Configuration Wizard runs from within SharePoint > Central Administration and will enable the user todo the following:

1. Install and deploy the SmartForms for SharePoint components automatically after the K2 Setup Manager is complete2. Manage the K2 for SharePoint solutions that are installed3. Activate the K2 Features

The Wizard will run automatically once the K2 Setup Manager has completed if the check box is selected on the Finish screen. Ashortcut, linking the user to the K2 for SharePoint Configuration wizard will be saved to the Start menu of the machine where theinstallation was performed. In a distributed environment this wizard must be run on each of the Web Front Ends.

Ensure that the SharePoint Application Pool Service is running before attempting to run this wizard.

The K2 for SharePoint Configuration Wizard landing page will prompt the user to select the method of configuration. For first timeuse, only the installation and deployment wizard is available. The management portion of the wizard is available after the initialusage of the wizard.

This wizard is the same wizard that is run when installing K2 blackpearl for the first time. Running the wizard after installing K2smartforms ensures that the SmartForms Web service, the SmartForms Viewer and the K2 Designer SmartForms Client Event isdeployed and activated. The following screens will be displayed during the configuration:

Fig.1 K2 for SharePoint Configuration wizard - Welcome Screen

Use the K2 for SharePoint Configuration wizard to configure the K2 for SharePoint components - The K2 forSharePoint configuration wizard will step the user through the required steps to configure the K2 for SharePoint solutions Use the Solutions management Form to manage existing K2 for SharePoint components (advanced) - This optionenables the user to manage the K2 for SharePoint Solutions package that is installed and deployed by the K2 for SharePointWizard. This option is not available immediately and does require existing solutions to be upgraded or for the K2 for SharePointcomponents to be installed.




Fig.2 K2 for SharePoint Configuration wizard - Prerequisite check Screen

The Prerequisite check page provides a list of prerequisites that need to be running while the actions are performed. Click onthe Repair button if the service is not running.

Fig.3 K2 for SharePoint Configuration wizard - Solution Installation Screen

The Solution Installation page provides a list of solutions that have been deployed during the K2 blackpearl installation and thetwo undeployed SmartForms solutions that will be installed automatically. This list is the entire K2 for SharePoint componentspackage and there may be inter-dependencies.




Fig.4 K2 for SharePoint Configuration wizard - Deploying Screen

Once the solutions have been installed, the next step is to deploy them. As shown in the screen shot above the status of thesolution indicates that deployment is required. The next step is to schedule the deployment by clicking Next.

The SharePoint page may at times appear to be unresponsive, seemed to have timed out or a "503 : Service Unavailable" error may display. Manually refreshthe page when this takes place.




Fig.5 K2 for SharePoint Configuration wizard - Solution Deployment Screen

If all the solutions have been installed successfully, the status will be changed to Deployed.

Fig.6 K2 for SharePoint Configuration wizard - Post Deployment Configuration Screen

Once this is complete, the final step is for the User to activate the SharePoint Features and deploy them to the Web Front ends.Within K2 there is a K2 Workflow Failover SharePoint Job definition. It is essentially a timer job that runs every minute andchecks a queue for Workflow modifications that need to be run against the K2 SharePoint Workflow. Every time a K2 workflow ismodified (i.e. task created, workflow completed) a check is performed to ensure the workflow is ready to accept the modification.If the workflow is not ready to be modified it will be queued for later execution by the Job Definition.




Fig.7 Activate all K2 Features and K2 Configuration Settings Screen

Activate the SmartForms features to the required Site Collections by clicking OK. To select a different site collection click thedown arrow under Activation Location to change the web application and select a new site collection.

If you are installing K2 smartforms in an environment with MOSS or WSS, you will need to activate the K2 Designer forSharePoint Versions Exceptions feature manually per Web Application. For SharePoint 2010 environments the SmartFormsinstaller will automatically activate this feature. For steps on activating this feature see Activating Managed Web ApplicationFeatures on MOSS and WSS .




8.2 Distributed Install

Distributed InstallInstalling K2 smartforms in a distributed environment requires the prerequisite being K2 Core which installs with K2 blackpearl tobe installed on the various machines. Run the K2 Setup Manager .exe to install K2 smartforms on each server selecting thecomponent to be installed on that machine. For a guide to possible deployment options refer to the Supported Topologies section.

Important Considerations

In a distributed installation the K2 Core or one of the K2 client tools components i.e. K2 Studio or K2 Designer for Visual Studiomust be installed on the K2 server machine.

Example

The diagram below is an example of a distributed environment with K2 smartforms installed.

The following K2 smartforms components are installed during the installation process:

Component Description Where to install it

K2 smartforms Contains the K2 smartforms server andperipherals

This component must be installed onthe server where the K2 blackpearl hostserver is configured to run

K2 Designer The designer that allows for the creation ofSmartObjects, Views, Forms and Workflows

This component can be installed on thesame server as the K2 Workspace or onany IIS site to have a distributedinstallation and split out your workspaceweb server from your SmartForms webserver . You can also split out yourdesign site from the runtime site.

SmartForms Runtime Allows for the runtime site to be installed on aweb server

This component can be installed on thesame server as K2 Workspace or on anyIIS site. This allows for a distributedinstallation and the ability to split outyour Runtime site from your DesignTime site by installing them on separateservers if required.

SmartForms forSharePoint

Installs the wsp solutions required by K2smartforms to the Web Front Ends

This component must be installed on allthe Web Front End servers

SmartForms ProcessWizards

These wizards surface in the K2 Designer forVisual Studio and K2 Studio and allowWorkflows to be started using SmartForms

Install this component on the clientmachines that have K2 Studio and K2Designer for Visual Studio installed.

K2 smartforms SetupManager

The Setup Manager allows for the futureremoval, repair, modification of K2

This is a required component and will beinstalled on all server and client




smartforms machines




8.2.1 Install and Configure the K2 smartforms Server

Install and Configure the K2 smartformsIn a distributed environment the SmartForms server must be installed on the K2 blackpearl server. Install thiscomponent on the same server as K2 blackpearl host server as the Setup Manager needs to connect to an existingK2 blackpearl instance (K2hostServer database). The flow diagram below shows the different wizard screens that willbe displayed, as well as the order in which they occur.




To install the K2 Server component, follow the steps below:

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



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




On the Select Components screen, ensure that the following check boxes areselected:

SmartForms K2 smartforms Setup Manager

On the Host Server Database Configurations screen, the SQL Servertext box should automatically populated with the SQL server name where K2blackpearl is installed. The database name can only be that which was selected /installed when K2 blackpearl was installed, the default being K2 (or K2HostServer forolder migrated installations). Select the Authentication mode to be used toauthenticate the connection to the SQL Server. When you have completed yourdatabase configuration, click Next to continueOn the Configuration Summary screen, validate the settings. You can go back tomake any necessary changes, and you can print this page for reference later. Onceyou are satisfied with your settings, click Install. Once the Setup Manager starts theinstallation, the process cannot be stopped.

On the Additional Actions screen the additional, required actions that need to beperformed will be displayed, for example IISRESET, by clicking Next these actionswill be performed by the K2 smartforms Setup Manager before starting theinstallation process. Alternatively, you can manually perform these actions and thenclick Refresh. Click Next to initiate the installation.The Setup Manager will update and show you the progress of the components as itinstalls on the Installing screen.


Once the components are installed and configured, the Configuration Analysis toolruns to verify settings.

When the installation has completed, you will see a finished screen. There will alsobe a link to the created configuration log file.

Recommendation: When the K2 Server is run in console mode make sure to be logged in as the correct user and make use of the “Run asAdministrator” option to ensure that the correct elevated privileges are utilized.




8.2.2 Install and Configure K2 Designer

Install and Configure K2 DesignerPost Installation

The K2 Designer allows for the creation of design site where SmartObjects, Views, Forms and Workflows can becreated. Install this component on the same server as K2 Workspace or on a web server that has IIS installed.





Prerequisite

Microsoft .NET Framework 4.5 (required for Design time and Runtime sites). Visit the following link to find out what.NET Framework version is currently installed: http://msdn.microsoft.com/en-us/library/hh925568.aspx

To install the K2 Designer component, follow the steps below:






K2 DesignerK2 smartforms Setup Manager (mandatory)

On the Host Server Database Configurations screen, the SQL Server text box shouldautomatically populated with the SQL server name where K2 blackpearl is installed. The databasename can only be that which was selected / installed when K2 blackpearl was installed, the defaultbeing K2 (or K2HostServer for older migrated installations). Select the Authentication mode to beused to authenticate the connection to the SQL Server. When you have completed your databaseconfiguration, click Next to continue

On the License Configuration screen, the user must enter the licensecorresponding to the system key displayed. This can be obtained using the keyrequest link on the screen

On the K2 Designer Web Site screen, type in the name of the new web site to becreated or select an existing web site from the drop down box. Click Next.

On the K2 Designer Site Application Pool screen, select to use an existingapplication pool from the drop down box or create a new one, and click Next. Theselected Application Pool account's Managed Pipeline mode must be set toIntegrated. The SmartForms’ Application Pool also needs to run on the .NETFramework v4.0.30319. If you have an existing SmartForms Application Pool running




on the .NET Framework v2.0.50727 and this application pool is used for otherapplications as well, a new application pool is required for K2 smartforms 1.0.4. Ifyou have an existing application pool running on the .NET Framework v2.0.50727that is only used for K2 smartforms, this application pool needs to be configured torun on the .NET Framework v4.0.30319.

On the Configuration Summary screen, validate the settings. You can go back tomake any necessary changes, and you can print this page for reference later. Onceyou are satisfied with your settings, click Install. Once the Setup Manager starts theinstallation, the process cannot be stopped.

On the Additional Actions screen the additional, required actions that need to beperformed will be displayed, for example IISRESET, by clicking Next these actionswill be performed by the K2 smartforms Setup Manager before starting theinstallation process. You can manually perform these actions and then click Refresh.Click Next to initiate the installation.The Setup Manager will update and show you the progress of the components as itinstalls on the Installing screen.




Post Installation

When K2 smartforms is installed in a distributed environment where the K2 Designer and SmartForms Runtimecomponents are installed on different IIS servers, certain Role Services must be enabled on the SmartFormsRuntime server. For steps on enabling these services see Selecting Role Services on IIS Server topic.If Internet Explorer is going to be the browser of choice then there are some post installation steps that mayapply to your environment, read the following topic for more information, Internet Explorer Settings.If K2 smartforms will be hosted in a SSL environment read the information in the Using K2 smartforms andSSL topic.




8.2.3 Install and Configure K2 smartforms Runtime Component

Install and Configure SmartForms Runtime Component

Post Installation

The SmartForms Runtime Site allows the user to execute Views and Forms. Install this component on the serverwhere at least the 4.6.5 K2 Core component is installed. If the Runtime Component is installed over multiple web-servers, the final server address is the default URL / role in the database.





Prerequisite

Microsoft .NET Framework 4.5 (required for Design time and Runtime sites). Visit the following link to find out what.NET Framework version is currently installed: http://msdn.microsoft.com/en-us/library/hh925568.aspx

To install the SmartForms Runtime component, follow the steps below:






SmartForms RuntimeK2 smartforms Setup Manager

On the Host Server Database Configurations screen, the SQL Server text box shouldautomatically populated with the SQL server name where K2 blackpearl is installed. The databasename can only be that which was selected / installed when K2 blackpearl was installed, the defaultbeing K2 (or K2HostServer for older migrated installations). Select the authentication mode to beused to authenticate the connection to the SQL Server. When you have completed your databaseconfiguration, click Next to continue

On the License Configuration screen, the user must enter the licensecorresponding to the system key displayed. This can be obtained using the keyrequest link on the screen

On the SmartForms Runtime Site screen, type in the name of the new web site tobe created or select an existing web site from the drop down box. Click Next.

On the SmartForms Runtime Site Application Pool screen, select to usean existing application pool from the drop down box or create a new one, and clickNext.The selected Application Pool account's Managed Pipeline mode must be set toIntegrated. The SmartForms’ Application Pool also needs to run on the .NETFramework v4.0.30319. If you have an existing SmartForms Application Pool running




on the .NET Framework v2.0.50727 and this application pool is used for otherapplications as well, a new application pool is required for K2 smartforms 1.0.4. Ifyou have an existing application pool running on the .NET Framework v2.0.50727that is only used for K2 smartforms, this application pool needs to be configured torun on the .NET Framework v4.0.30319.

On the Configuration Summary screen, validate the settings. You can go back tomake any necessary changes, and you can print this form for reference later. Onceyou are satisfied with your settings, click Install. Once the Setup Manager starts theinstallation, the process cannot be stopped.



Once the components are installed and configured, the Configuration Analysis tool runs to verifysettings. The tool will display a warning or error icon If issues are discovered. These can be repairedby the tool it self by clicking Repair All


Post Installation

When K2 smartforms is installed in a distributed environment where the K2 Designer and SmartForms Runtimecomponents are installed on different IIS servers, certain Role Services must be enabled on the SmartFormsRuntime server. For steps on enabling these services see Selecting Role Services on IIS Server topic.If Internet Explorer is going to be the browser of choice then there are some post installation steps that mayapply to your environment, read the following topic for more information, Internet Explorer Settings.If K2 smartforms will be hosted in a SSL environment read the information in the Using K2 smartforms andSSL topic.




8.2.4 Install and Configure SmartForms for SharePoint

Install and Configure SmartForms for SharePointPost Installation

The SmartForms for SharePoint installs the wsp solution files required for the deployment and activation of theSmartForms features namely the web service and the SmartForms Viewer. Install this component on all the WebFront End servers.










SmartForms for SharePointK2 smartforms Setup Manager (mandatory)

On the Host Server Database Configurations screen, the SQL Servertext box should automatically populated with the SQL server name where K2blackpearl is installed. The database name can only be that which was selected /installed when K2 blackpearl was installed, the default being K2 (or K2HostServer forolder migrated installations). Select the Authentication mode to be used toauthenticate the connection to the SQL Server. When you have completed yourdatabase configuration, click Next to continueOn the Configuration Summary screen, validate the settings. You can go back tomake any necessary changes, and you can print this Form for reference later. Onceyou are satisfied with your settings, click Install. Once the Setup Manager starts theinstallation, the installation cannot be stopped.





When the installation has completed, you will see a check box on the finished screenthat will launch the K2 for SharePoint Configuration Wizard. This wizard must berun to deploy and activate the SmartForms features in the SharePoint SiteCollections. If left unchecked the wizard must be manually run from the K2 forSharePoint Configuration Wizard link in the K2 blackpearl > K2 smartforms StartMenu for the SmartForms component to function.

Post Installation

If MOSS and WSS are installed then read the information in the Activating Managed Web Application Features onMOSS and WSS topic to ensure all the features are activated.




8.2.5 Install and Configure Client Components

Install and Configure SmartForms Process WizardsPost Installation

The SmartForms Process Wizards display in K2 Studio and K2 Designer for Visual Studio. Install this component onall client machines.






SmartForms Process WizardsK2 smartforms Setup Manager (Mandatory)

On the Host Server Database Configurations screen, the SQL Servertext box should automatically populated with the SQL server name where K2blackpearl is installed. The database name can only be that which was selected /installed when K2 blackpearl was installed, the default being K2 (or K2HostServer forolder migrated installations). Select the Authentication mode to be used toauthenticate the connection to the SQL Server. When you have completed yourdatabase configuration, click Next to continueOn the Configuration Summary screen, validate the settings. You can go back tomake any necessary changes, and you can print this Form for reference later. Onceyou are satisfied with your settings, click Install. Once the Setup Manager starts theinstallation, the Workflow cannot be stopped.





Post Installation

If Internet Explorer is going to be the browser of choice then there are some post installation steps that mayapply to your environment, read the following topic for more information, Internet Explorer Settings.If K2 smartforms will be hosted in a SSL environment read the information in the Using K2 smartforms andSSL topic.




8.3 Unattended Installer

Unattended Installer The unattended installation uses an XML file to install and configure the operating system, there is minimalinteraction by administrators or technicians during the setup process.

Greater consistency during a rollout

By using the same XML file to install and configure the operating system, you can ensure that all of the computers inyour organization are set up exactly the same way.

Limitations

The installer does not support Modify or Repair.To perform a repair and modify open the K2 Setup Manager andperform the actions through the UI.

Shorter installation times

The unattended installation is faster than interactive setup because Setup does not have to prompt administrators ortechnicians for configuration information and wait for them to enter it; instead, Setup reads configuration settingsfrom the XML file.

Unattended Installation Dependencies

Generate System Key

Generate Silent / Unattended Installation XML File

Silent / Unattended Installation (using the XML File)

Unattended Distributed Installation

Unattended Installer - Upgrade

Setup Options

Additional Notes




8.3.1 Unattended Installation Dependencies

Unattended Installer Dependencies To perform an unattended installation, you need the following:

System Key - Generate System KeyLicense KeyOperating system files, including the Windows Setup programs installed (K2 Component Dependencies)XML File - Generate Silent / Unattended Installation XML File

The Setup Manager is a wizard-like tool that prompts you for a series of configuration parameters, and then writes your responses to aXML file.




8.3.2 Generate System Key

Unattended Installer - Generate System KeyRun setup.exe /systemkey:"{path}" from the command prompt, this will generate the System Key.

Parameters

{path} This is the path where the application will be installed. This is required togenerate the System Key.

Output:

Prints the System Key to the console window in this format System Key: xxxxxxxxxxxxxxxx




8.3.3 Generate Silent / Unattended Installation XML File

Generate Silent / Unattended Installation XML FileRun setup.exe /output:"{filename}" which will open the Setup wizard to obtain all settings from user, click onFinish to generate an XML file with user-specific settings.

The XML configuration file is used for silent/unattended installation.

The following command does not install, just builds the XML file:

Syntax:

setup.exe /output:"{filename}"

Parameters

{filename} This is the name of the XML file that will be generated.

Output:

Launches the Installer UI, gathers all the information, and then closes upon creating the XML file containing all theoptions as specified in the Installation wizard.




8.3.4 Silent / Unattended Installation (using the XML File)

Silent / Unattended Installation (using the XML File)Install K2 without any user input, by simply running setup.exe /install:"{filename}" /loglevel:{loglevel} with avalid XML configuration file.

Parameters

{filename} The name of the XML file with all the installation options (including System Key andLicense Key).

{loglevel} An optional parameter that specifies the Log Level, based on the following list:

1 – Verbose Logging

2 – Information, Warning and Errors

3 – Warning and Errors Only (Default)

4 – Errors Only

Note: If this parameter is not specified, the default is ‘3’.

Output:

Print the progress and any errors for the installation/configuration to the command window.

The Setup.exe command can determine whether the setup being run is for a new installation, or for a configuration.




8.3.5 Unattended Distributed Installation

Unattended Installer - Unattended Distributed InstallationA distributed installation XML file can be created by removing certain components from a Full Installation XML file.

The K2 Pass-Through Authentication option is only valid for a distributed installation see the section on Additional Notes

Distributed Installation Steps:

Open the Command Prompt, and type the following syntax: C:\Pearl>setup.exe/output:unattended.xml to start building the XML file. Where Pearl is the installation folder.

The K2 Setup Manager will start.

It is recommended to do a Full Installation (all components selected on the Select Componentsscreen).

This will not install the components, it only builds the XML file.

When the installation is complete, the XML file can be edited by using a text editor such as Notepad.

A distributed installation XML file can then be saved by deleting components from the 'FullInstallation' XML file, as required.

Please note that the Configuration component is required to be installed with all the othercomponents.

After the XML file is built and edited the following command will start the installation:

Syntax: c:\Pearl>setup.exe /install:unattended.xml




8.3.6 Unattended Installer - Upgrade

Unattended Installer - UpgradeWhen upgrading using the Unattended Installer, the component section of the XML file is ignored, only previously installed components willbe upgraded. With the exception of K2 blackpoint, where the K2 Workspace component will be installed when upgrading to K2 blackpearl.

To run the Unattended Upgrade installer the following command is used:

Syntax:

setup.exe /upgrade:"{filename}"

Parameters

{filename} This is the name of the XML file that will be used for the upgrade installation.

Output:

Launches the Setup Manager and then starts the upgrade.

Upgrade Steps:

It is recommended to use the XML file that was used during a Full Installation for the XML Upgrade file.

This will not install new components, it only upgrades the installed components.

The following XML file variables can be edited as required to create the XML Upgrade file:

Copy K2 Service User name and password variables

<add key="[USERSNAME]" value="K2WORKFLOW\User"/><add key="[USERSPASS]" value="Pass"/>

Copy K2 Host Server

<add key="[HOSTSERVERDBNAME]" value="K2HostServer"/><add key="[HOSTSERVERCONNECTIONSTRING]" value="Data Source=SA-SCINSTALL2\instance01;Initial Catalog=K2HostServer;integratedsecurity=sspi"/><add key="[HOSTSERVERDBSQLSERVER]" value="SA-SCINSTALL2\instance01"/>

After editing the XML file, open the Command Prompt, and type the following syntax:C:\Pearl>setup.exe /upgrade:"Upgrade.xml" to start the XML file.

The K2 Setup Manager will start.

When the upgrade installation is complete, the XML file can be edited by using a text editor such as Notepad.




8.3.7 XML File Parameters

Unattended Installer - XML File ParametersThe table below provides information on the parameters that can be edited in the Installation XML file:

Example Installation XML File ParameterUsed For:

ComponentApplicable For:

What can bechanged?

<PRODUCT> Start ofproductvariables

All N/A

<COMPONENTS> Start ofcomponentsgroup

All N/A

<SERVER_SF /> InstallingSmartFormsServerComponent

SmartForms Server Can beremoved toNOT installSmartFormsServer

<WEB_SF /> Installing K2DesignerComponent

K2 Designer Can beremoved toNOT install K2Designer

<RUNTIME_SF /> InstallingSmartFormsRuntimeComponent

SmartFormsRuntime

Can beremoved toNOT installSmartFormsRuntime

<SHAREPOINT_SF /> InstallingSmartFormsfor SharePointComponent

SmartForms forSharePoint

Can beremoved toNOT installSmartFormsfor SharePoint

<CLIENT_SF /> InstallingSmartFormsClientComponent

SmartForms ClientComponent

Can beremoved toNOT installSmartFormsClient

<CONFIGURATION_SF /> Installing K2smartformsSetupManagerComponent

K2 smartformsSetup ManagerComponent

N/A

</COMPONENTS> End ofcomponentsgroup

N/A N/A

<VARIABLES> Start ofvariablesgroup

N/A N/A

<add key="[MACHINEKEY]" /> N/A N/A N/A

<add key="[INSTALLDIR]">C:\Program Files(x86)\K2 blackpearl\

N/A N/A N/A

<add key="[SIMPLEINSTALL]">false N/A N/A N/A

<add key="[ISNLB]">false N/A N/A N/A

<add key="[REPORTPORTSITE]">SA-DC-PETER:321/ReportServer_INSTALLTEST

N/A N/A N/A




<add key="[REPORTSITENAME]" /> N/A N/A N/A

<add key="[REPORTSERVERVDIR]">ReportServer_INSTALLTEST

N/A N/A N/A

<add key="[REPORTPORTSITEURL]">http://SA-DC-PETER:321/

N/A N/A N/A

<add key="[REPORTSITEPATH]" /> N/A N/A N/A

<add key="[FULLREPORTSITEURL]">http://SA-DC-PETER:321/ReportServer_INSTALLTEST

N/A N/A N/A

<add key="[SETSITESPN]">False N/A N/A N/A

<add key="[SETSPN]">False N/A N/A N/A

<add key="[USRMGRTYPE]">UMTYPE_ADUM N/A N/A N/A

<add key="[LICENSEUSER]" /> N/A N/A N/A

<add key="[SA-DC-PETER]"> N/A N/A N/A

[RUNTIME_PROCESSORS] Value=0 N/A N/A N/A

[RUNTIME_USERS] Value=0 N/A N/A N/A

[RUNTIME_EXPIREDATE] Value=16 September 2012 N/A N/A N/A

[RUNTIME_EXPIRES] Value=True N/A N/A N/A

[RUNTIME_LICENSETYPE] Value=EVALUATION N/A N/A N/A

[RUNTIME_MACHINEKEY]Value=866CXXXXX0BC22FF

N/A N/A N/A

[RUNTIME_LICENSEDPRODUCT] Value=K2BLACKJAX N/A N/A N/A

[RUNTIME_WFENAME] Value=SA-DC-PETER N/A N/A N/A

[FORMS_PROCESSORS] Value=0 N/A N/A N/A

[FORMS_USERS] Value=0 N/A N/A N/A

[FORMS_EXPIREDATE] Value=16 September 2012 K2 Designerlicense expirydate

K2 Designercomponent

N/A

[FORMS_EXPIRES] Value=True K2 Designerlicenseexpirationindicator

K2 Designercomponent

N/A

[FORMS_LICENSETYPE] Value=EVALUATION License Type All N/A

[FORMS_MACHINEKEY] Value=866C3D7C50BC22FF K2 Designermachine key

All N/A

[FORMS_LICENSEDPRODUCT] Value=K2BLACKJAX Productindicator

All N/A

[FORMS_WFENAME] Value=SA-DC-PETER K2 Designerweb front endname

All K2 Designerweb front enddetails

[RUNTIME_LICENSEKEY]Value=6906319C4E1F59485349

License key SmartFormsRuntime

License key

[PREVK2SITENAME] Value=K2Workspace N/A N/A N/A




[OLD_K2SFSITEURL] Value= Legacy K2Designer siteIURL

SmartFormsruntime site

N/A

[K2SFSITEID] Value=2 K2 Designersite ID

K2 Designer K2 Designersite ID

[K2SFSITENAME] Value=K2Workspace K2 Designersite name

K2 Designer K2 Designersite name

[K2SFSITEURL] Value=http://SA-DC-PETER:81 K2 Designersite URL

K2 Designer K2 Designersite URL

[K2SFAPPPOOL] Value=workspace appool K2 Designerapplicationpool name

K2 Designer K2 Designerapplicationpool name

[SFUSER] Value=INSTALL\wsappooluser K2 Designerapplicationpool username

K2 Designer SmartFormsDesignerapplicationpool username

[OLD_K2RUNTIMESITEURL] Value= LegacySmartFormsruntime siteURL

SmartFormsruntime site

N/A

[K2RUNTIMESITEID] Value=2 SmartFormsRuntime siteID

SmartFormsruntime

SmartFormsRuntime siteID

[K2RUNTIMESITENAME] Value=K2Workspace SmartFormsRuntime sitename

SmartFormsruntime, K2Designer

SmartFormsRuntime sitename

[PRIMARY_RUNTIME] Value=http://SA-DC-PETER:81 Defaultruntime URL

All Defaultruntime URL

[K2RUNTIMESITEURL] Value=http://SA-DC-PETER:81

SmartFormsRuntime siteURL

SmartFormsServer, SmartFormsRuntime

SmartFormsRuntime siteURL

[K2RUNTIMEAPPPOOL] Value=workspace appool SmartFormsRuntimeapplicationpool name

SmartForms Server,K2 smartformsRuntime

SmartFormsRuntimeapplicationpool name

[RUNTIMEUSER] Value=INSTALL\wsappooluser SmartFormsRuntimeapplicationpool username

SmartForms Server,SmartFormsRuntime

SmartFormsRuntimeapplicationpool username

<add key="[LICENSEPASS]">866C3D7C50BC22FF N/A N/A N/A

<add key="[HOSTSERVERDBNAME]">K2hostserver N/A N/A N/A

<add key="[HOSTSERVERCONNECTIONSTRING]">DataSource=SA-DC-PETER\installtest;InitialCatalog=K2hostserver;integratedsecurity=sspi;Pooling=True

N/A N/A N/A

<add key="[HOSTSERVERDBSQLSERVER]">SA-DC-PETER\installtest

N/A N/A N/A

<add key="[LBHOSTSERVERNAME]">SA-DC-Peter N/A N/A N/A

<add key="[SFPASS]" /> N/A N/A N/A

<add key="[RUNTIMEPASS]" /> N/A N/A N/A




</VARIABLES> End ofVariablesgroup

N/A N/A

</PRODUCT> End of Productgroup

N/A N/A




8.3.7.1 Full Installation XML - Example

Unattended Installer - Full Installation XML FileThe following XML code is an example of a Full installation:

Copy Full Installation XML

<PRODUCT> <COMPONENTS> <SERVER_SF /> <WEB_SF /> <RUNTIME_SF /> <SHAREPOINT_SF /> <CLIENT_SF /> <CONFIGURATION_SF /> </COMPONENTS> <VARIABLES> <add key="[MACHINEKEY]" /> <add key="[INSTALLDIR]">C:\Program Files (x86)\K2 blackpearl\</add> <add key="[SIMPLEINSTALL]">false</add> <add key="[ISNLB]">false</add> <add key="[REPORTPORTSITE]">SA-DC-PETER:321/ReportServer_INSTALLTEST</add> <add key="[REPORTSITENAME]" /> <add key="[REPORTSERVERVDIR]">ReportServer_INSTALLTEST</add> <add key="[REPORTPORTSITEURL]">http://SA-DC-PETER:321/</add> <add key="[REPORTSITEPATH]" /> <add key="[FULLREPORTSITEURL]">http://SA-DC-PETER:321/ReportServer_INSTALLTEST</add> <add key="[SETSITESPN]">False</add> <add key="[SETSPN]">False</add> <add key="[USRMGRTYPE]">UMTYPE_ADUM</add> <add key="[LICENSEUSER]" /> <add key="[SA-DC-PETER]"><Vars><Var Name="[RUNTIME_PROCESSORS]" Value="0" /><VarName="[RUNTIME_USERS]" Value="0"/><Var Name="[RUNTIME_EXPIREDATE]" Value="16September 2012" /><Var Name="[RUNTIME_EXPIRES]" Value="True" /><VarName="[RUNTIME_LICENSETYPE]"Value="EVALUATION" /><Var Name="[RUNTIME_MACHINEKEY]" Value="866C3D7C50BC22FF"/><Var Name="[RUNTIME_LICENSEDPRODUCT]"Value="K2BLACKJAX" /><Var Name="[RUNTIME_WFENAME]" Value="SA-DC-PETER" /><VarName="[FORMS_PROCESSORS]" Value="0"/><Var Name="[FORMS_USERS]" Value="0"/><Var Name="[FORMS_EXPIREDATE]" Value="16September 2012" /><Var Name="[FORMS_EXPIRES]"Value="True" /><Var Name="[FORMS_LICENSETYPE]" Value="EVALUATION" /><VarName="[FORMS_MACHINEKEY]"Value="866C3D7C50BC22FF" /><Var Name="[FORMS_LICENSEDPRODUCT]" Value="K2BLACKJAX"/><Var Name="[FORMS_WFENAME]" Value="SA-DC-PETER" /><Var Name="[RUNTIME_LICENSEKEY]"Value="6906319C4E1F59485349" /><Var Name="[PREVK2SITENAME]" Value="K2Workspace" /><VarName="[OLD_K2SFSITEURL]" Value=""/><Var Name="[K2SFSITEID]" Value="2"/><Var Name="[K2SFSITENAME]"Value="K2Workspace" /><Var Name="[K2SFSITEURL]" Value="http://SA-DC-PETER:81"/><Var Name="[K2SFAPPPOOL]" Value="workspaceappool" /><Var Name="[SFUSER]"Value="INSTALL\wsappooluser" /><Var Name="[OLD_K2RUNTIMESITEURL]" Value="" /><VarName="[K2RUNTIMESITEID]" Value="2"/><Var Name="[K2RUNTIMESITENAME]"Value="K2Workspace" /><Var Name="[PRIMARY_RUNTIME]" Value="http://SA-DC-PETER:81"




/><Var Name="[K2RUNTIMESITEURL]"Value="http://SA-DC-PETER:81" /><Var Name="[K2RUNTIMEAPPPOOL]" Value="workspace appool"/><Var Name="[RUNTIMEUSER]"Value="INSTALL\wsappooluser" /></Vars></add> <add key="[LICENSEPASS]">866C3D7C50BC22FF</add> <add key="[HOSTSERVERDBNAME]">K2hostserver</add> <add key="[HOSTSERVERCONNECTIONSTRING]">Data Source=SA-DC-PETER\installtest;Initial Catalog=K2hostserver;integratedsecurity=sspi;Pooling=True</add> <add key="[HOSTSERVERDBSQLSERVER]">SA-DC-PETER\installtest</add> <add key="[LBHOSTSERVERNAME]">SA-DC-Peter</add> <add key="[SFPASS]" /> <add key="[RUNTIMEPASS]" /> </VARIABLES></PRODUCT>




8.3.8 Setup Options

Get a list of Setup.exe OptionsRun setup.exe /? to determine all command line options.

Usage

setup.exe [/systemkey:"{path}" | /output:"{filename}" |

/? | /install:"{filename}" /loglevel:{loglevel} |

/upgrade:"{filename}" | /config:"{filename}" |

/configcomps:{components} |

/var:"{varname}={varvalue}" |

/remove | /analyze | /noval]

Options

/systemkey Print the System Key for this server to the console.

/output Generate an XML Configuration File after gathering info.

/install Run the silent installer with the specified XML file.

/loglevel Specify the Log Level to be used (Optional).

/upgrade Run the silent installer with the specified XML file.

/config Configure an existing installation.

/configcomps Configure specified components.

/var Override a configuration variable during installation.

/remove Remove an existing installation.

/analyze Analyze an existing installation to see if it is valid.

/noval Strips validation from the Next button on 3 installer panels: CRM, Exchange &SmartActions. This means that no validation will take place if the Next button is clicked.

Note that the Test button on those panels will still perform validation. This action is also logged fortroubleshooting purposes.

Parameters

path The path to the folder where K2 will be installed.

filename The filename (and path) to the XML file that will contain the installation configuration.

components Comma separated list of components to configure.

This is not silent and will bring up the configuration wizard for the selected components.

Setup.exe /configcomps:SERVER

Possible component names to use for the /configcomps command:SERVER - K2 blackpearl ServerWORKSPACE - K2 Workspace configMOSS - K2 for SharePoint configWEBDESIGNER - K2 Designer for SharePointSTUDIO - K2 for Visual Studio configK2STUDIO - K2 Studio

loglevel The log level to be used for the installation log.

1 – Verbose Logging

2 – Information, Warning and Errors

3 – Warning and Errors Only (Default)

4 – Errors Only




varname Configuration variable name to override during installation.

varvalue Value to set the specified configuration variable to during installation.

Examples

setup.exe /? Will display the command line options.

setup.exe /output:MyConfig.xml Launch the Setup wizard and output the settings to‘MyConfig.xml’ file.

setup.exe /systemkey:”C:\Program Files\K2blackpearl”

Output the System Key to the Console.




8.3.9 Additional Notes

Unattended Installer - Additional NotesAll command line parameters are case insensitive. For example, both of these will work identically:

setup.exe /SystemKeysetup.exe /systemkey

All command line parameters can use either “/” or “-“ to indicate a switch. For example, both of these will workidentically:

setup.exe /systemkey /path:{installpath}setup.exe –systemkey –path:{installpath}

If the names of files contain spaces, then the user must enclose them in quotes. For example: setup.exe/output:"My Output File.xml"

If the user does not specify a path (but rather just the filename), it is assumed that the file will be created in thesame directory as 'setup.exe' - this applies to all parameters that accept a filename. Alternatively, any ‘filename’parameter will also function if the user has specified a path.

Example: setup.exe /output:"C:\My Configs\My File.xml" 1

The Setup Manager will verify that the path is valid and immediately raise an error (to the console) if it is incorrect.

K2 Pass Through AuthenticationK2 Pass-Through Authentication is only available for K2 Server when installed in a distributed configuration

K2 Pass-Through Authentication can be configured using the unattended installer however, the default behavior ofthe unattended installer differs from the normal installer. By default the XML file will generate with the K2 Pass-Through Panel set to Kerberos, but this setting differs from the Installer which is set to Windows. This setting hasbeen enabled as a precaution to ensure that for existing environments where Kerberos has been configured, theseenvironments are not affected negatively by the introduction of K2 Pass-Through Authentication.

To correct this, the XML file must be regenerated with the following :

Alter the K2 Pass-Through Authentication Option to : WindowsChange the XML file Path to Setup.exe” /output:MyFIle.xml




9 Post Install




9.1 Using K2 smartforms and SSL

Using K2 smartforms and SSLIf client certificates are enabled on a default Internet Information Services server on which K2 smartforms is run, thefollowing error might occur when uploading large files:

HTTP 413: Request entity too large

To fix this, change the value of UploadReadAheadSize metabase property to a value larger than the contentlength.

Follow the steps below to set UploadReadAheadSize in the applicationhost file:

Locate appcmd.exe in \windows\system32\inetsrv folderRun the following command in the command line toolappcmd.exe set config -section:system.webserver/serverruntime/uploadreadaheadsize: {sizeinbytes}/commit:apphost

For more information on this issue, read the Microsoft Technet KB article. Please note that there is an error in theTechNet documentation that explains how to do this.

The link instructs you to set the size as follows:

cscript adsutil.vbs set w3svc/1/uploadreadaheadsize 200

Which should read:

cscript adsutil.vbs set w3svc/1/uploadreadaheadsize 204800

The metabase setting is represented in bytes, not KB as the TechNet article would suggest.




http://www.microsoft.com/technet/prodtechnol/WindowsServer2003/Library/IIS/7e0d74d3-ca01-4d36-8ac7-6b2ca03fd383.mspx?mfr=true

9.2 Selecting Role Services on IIS Server

Selecting Role Services on IIS ServerWhen K2 smartforms is installed in a distributed environment where the K2 Designer and SmartForms Runtime components are installedon different IIS servers, certain Role Services must be enabled on the SmartForms Runtime server. Follow the steps below to enable theseRole Services:

On the SmartForms Runtime server open the Server Manager (Start> Administrative Tools> Server Manager)

Expand the Roles node.

Right-click on the Web Server (IIS) node and select Add Role Services




Select the following Role Services check boxes:Under the Common HTTP Features (Installed) node (all are required)

Static Content (Installed)Default Document (Installed)Directory Browsing (Installed)HTTP Errors (Installed) (Installed)HTTP Redirection

Under Application Development

ASP .NET.NET ExtensibilityASPISAPI ExtensionsISAPI Filters

Under the Security (Installed) node

URL Authorization (Installed)

Under the Performance (Installed) node

Static Content Compression (Installed)Dynamic Content Compression (Installed)




9.3 Activating Managed Web Application Features on MOSS and WSS

Activating Managed Web Application Features on MOSS and WSSWhen MOSS or WSS are used in SmartForms environment it is necessary to manually activate the K2 Designer for SharePoint VersionExceptions feature after the K2 smartforms installation and SharePoint Configuration wizard is complete. Activate this feature on eachWeb Application where the K2 Designer for SharePoint is used. This feature will configure K2 Designer for SharePoint to make use of thelatest K2 smartforms plugin. This includes components such as the Forms Task located in the User Task menu. Failure to activate thisfeature will result in a file not found error when the Forms task is dragged onto the design canvas.

To activate the feature follow the steps below:n

Open Central Administration

Browse to Application Management >Web Application > Web Application Management Features

Find the K2 Designer for SharePoint Version Exceptions and click the Activate button.

This only applies to MOSS and WSS. The K2 smartforms Setup Manager will automatically update and configure this feature in SharePoint 2010.




9.4 Internet Explorer Settings

Internet Explorer SettingsIt is recommended that the Design Time and the Runtime Sites are added to the Local Intranet of Trusted SitesZones. This is particularly required if the Internet Explorer Enhanced Security Configuration is enabled. Failure to addthe sites to the Trusted Sites Zone could prevent the SmartForms Design and Runtime sites from displaying correctlyin Internet Explorer.

Machines that should be set are:

ServersClient machines

To add the sites to the Local Intranet of Trusted Sites Zones follow the steps below:

1. Visit the SmartForms site that you want to add.2. Click on the Internet Explorer Tools icon in IE 9.3. Select the Security Tab.4. Click on the Local Intranet icon and click the Sites button.5. Click on the Advanced button.6. Type the K2 Design Time Site URL in the Add this website to the zone textbox and click the Add button.7. Type the SmartForms Runtime Site URL in the Add this website to the zone textbox and click the Addbutton.

8. Click Close.9. Click OK.10. Click OK.




10 Maintenance

MaintenanceOnce you have K2 smartforms up and running in your environment, there may be times when you need to modifycomponents or change configuration settings. This can be accomplished by re-running the Setup Manager (to add orremove components), or re-running the Setup Manager (to change configuration settings).

When you run the K2 Setup Manager again, you will see four options:

K2 Maintenance

Configure Re-configures the existing K2 smartforms Installation

Remove Removes the existing K2 smartforms Installation completely (including all components) fromthe target system.

Modify Modifies the existing installation by either adding or removing components1

Repair The repair option re-installs the components currently installed on the local, target system.

UpdateLicense

The update option enables the user to reconfigure the license key when needed tobe updated

1 The K2 Setup Manager may need to be run once the changes have been made.

If any change is made to the K2 Designer web site the users must clear their browser cache for the changes to reflect.

Managing K2 Components

The K2 smartforms components are listed in the Add or Remove Programs. However, the components are notmanaged from this location.The K2 Setup Manager will need to be opened in order to manage the components. The Setup Manager can beaccessed from the original source or from the menu option under Start > Program files > K2 blackpearl > K2smartforms> K2 smartforms Setup ManagerThe K2 blackpearl Setup Manager can not be used to remove K2 smartforms or vice versaWhen reconfiguring K2 blackpearl, K2 smartforms must also be reconfigured




10.1 Configure

Configuring the K2 smartforms InstallationIf, after the initial installation of K2 smartforms, some components need to be reconfigured, rerunning the K2 SetupManager will allow you to reconfigure those components. After selecting Configure from the initial screen, you canconfigure all the installed components. Follow the prompts through the wizard and restart the K2 server after theconfiguration is finished.

The Configure K2 smartforms option configures all the installed K2 component configuration files and databasescripts.




10.2 Modify

Modifying the K2 smartforms Installation

If, after the initial installation of K2 smartforms, additional components are to be added to an existing server,rerunning the K2 Setup Manager will allow you to add new components.

After selecting Modify from the initial screen, you can select components to add by checking the check box next tothe listed component, or remove an existing component by unchecking the check box next to an installedcomponent.

The Modify option allows you to selectively add and remove K2 smartforms components. You can install and removedifferent components during the same session of Modify. For example, you can select to uninstall a component whileat the same time installing a different component.

Please note the following important facts regarding Modify:

1. When running Setup.exe from a temporary folder (where you copied/extracted the installer to), andcomponents have been installed previously, the modify option will show you all the components, because itdetects the msi files in the Setup folder.

2. When running the Setup.exe from the folder where K2 smartforms had been installed to, the Modify optionwill only show those components that are installed. You can then select which ones to remove. It will NOTshow you components that have not been installed. This is because the msi files are not installed to the K2smartforms install directory. This means you cannot add components by running Setup.exe from this folder.You have to run it from the original setup folder that contains the msi files, or start the Setup Manager fromthe Start menu.

Before adding a new component, you should evaluate your K2 environment and make sure that the target server is agood fit for your requirements. Then, determine if all the prerequisites are met, and then run the K2 Setup Managerto add and configure the new components.




10.3 Repair

RepairRepairing a K2 component is completed by rerunning the K2 Setup Manager and selecting repair. All the currentlyinstalled components on the server will be repaired. The repair process is essentially a reinstallation of all of thepreviously installed components. Therefore, you should back up the K2 databases and additional configuration files ifyou made any changes. A single component cannot be repaired. Selecting the Repair option will reinstall all K2smartforms components that are currently installed on that server. After you select repair, you will be prompted tostop any running programs and services that use K2 components. The Setup Manager can stop the K2 Service as wellas Visual Studio and K2 Studio for you, but you will need to close other programs manually. You should validate yourenvironment after a repair to ensure that your system is functioning properly.

Repairing a K2 smartforms installation should be done only when absolutely necessary and only when components have been damaged byexternal circumstances.




10.4 Remove

Removing K2 smartforms

Removing K2 smartforms is essentially a reversal of the Installation and Configuration process. The Setup Managerwill identify the components installed and remove them completely from the target system. The process starts byrunning the K2 smartforms Setup Manager and selecting the option to Remove K2 smartforms.

This article walks through the steps to remove K2 smartforms from a single server. For a distributed environment,perform these steps on all servers that have K2 smartforms installed

If you have installed K2 smartforms in a distributed environment, uninstall all client components first. Then, uninstallthe server components in the following order:

SmartForms for SharePointK2 DesignerSmartForms RuntimeK2 smartforms

Be sure to uninstall all other components first, ending with the Server component

To uninstall, perform the following steps:

1. Shut down all K2 related Workflows (K2 smartforms Designer, K2 Designer for Visual Studio, K2 Studio, K2Workflow Designer, K2 Designer for SharePoint, K2 blackpearl Server service)

2. Run the installation manager (Setup.exe) and select Remove K2 smartforms3. Follow the prompts through the wizard and reboot after the uninstall is finished.

This will remove all components from the target system. You will be prompted to continue. If you want to removejust a single component, select Modify from the maintenance home page.




You cannot use K2 blackpearl Setup Manager to remove K2 smartforms or vice versaIf you remove K2 blackpearl - K2 smartforms will no longer function and will have to be removed as it relies on K2 blackpearl to be in theenvironment.




10.5 Update License

Updating the K2 smartforms LicenseThere are two ways to update the K2 smartforms License Key:

Using the License Management functionality in K2 Workspace. For more information, please refer to the K2Workspace portion of the K2 blackpearl User Guide.Another way to update the K2 smartforms License Key is to re-run the Setup Manager. A user will need theirSystem Key and License Key before they can complete the Setup Manager. To update, run the Setup Manager onthe K2 Server and select the Update the K2 smartforms license option. Click Next till you get to the LicenseConfiguration screen. Enter the new license key and continue through the wizard to finish the configuration.




11 Authentication

SmartForms AuthenticationDesign Time/Runtime Permissions

SmartForms uses the K2 blackpearl security mechanisms which are the following:

Windows Authentication - Uses standard Windows authentication to automatically log in on K2 Host Server as the current user.The K2 label will be used.Forms Authentication - A specific Security Provider label has to be provided. The user will be required to provide a username andpassword as well as the label to log on. Forms Authentication uses the forms login screen and creates an encrypted authenticationticket using ASP.NET Forms Authentication for a successful login. The ticket details of the user are subsequently used for allconnections to the K2 Host Server.

The type of authentication is automatically set by the K2 smartforms installer according to the User Manager that is used on the specificenvironment. If Active Directory is used on the environment, the authentication mode will default to Windows. If any other User Manageris used, the authentication mode will default to Forms. The authentication mode is applicable on a site level, so authentication is appliedon the K2 site in Internet Information Services (IIS) in the case of SmartForms if the default site was used in the installer.

Should the need arise to change the type of authentication, it can be done by changing the web.config file of the IIS site whereSmartForms resides. Follow the steps below to change the security mechanism:

1. Open Internet Information Services (IIS)2. Open the site where SmartForms has been installed3. Click on Explore in the Actions panel on the right4. Scroll down to the bottom until you find the web.config file

5. Right-click the file and select Open With > Notepad6. Search for the following "<authentication mode"7. Change the type to the required mode either Windows or Forms




8. Save the file9. If Forms Authentication is selected, the following step is also required:In the web.config file search for “windowsAuthentication enabled”. Change the windowsAuthentication enabled from “true” to“false”




If this change is not done when using Forms Authentication, the following error will appear:

The login screen will be activated every time the user logs into the site.

Tick the Remember Me option in order to avoid the login screen being activated every time the user logs into the site

User Name The identity can be specified in one of the following formats:

“user name” Authenticates with and without the current domain against all security labels.




“K2 label:user name” Authenticates with and without the current domain against thespecified security label.

“domain\user name” Authenticates with the specified domain against all specified securitylabels.

“K2 label:domain\user name” Authenticates with the specified domain against thespecified security label.

Password Can include upper and lower case letters, numbers and symbols.

Design Time/Runtime Permissions

No extra permissions are required for SmartForms to work. SmartForms uses K2 blackpearl permissions and rights with regards toSmartObjects and Workflows.

However, rights can be set in IIS on the design time site level or on the runtime site level. The design time site and runtime site havedifferent web.config files and each site can be set up to use its own type of security mechanism. This enables administrators to allowcertain people to design SmartForms and other people to use SmartForms in runtime.

Follow the method mentioned above to set rights on the SmartForms sites. Alternatively, set the rights in the web.config files that can belocated in the following locations:

Designer: C:\Program Files (x86)\K2 blackpearl\K2 smartforms Designer\Web.config

Runtime: C:\Program Files (x86)\K2 blackpearl\K2 smartforms Runtime\Web.config




11.1 Anonymous Access

Anonymous AccessIf public users, who don't belong to a company's Active Directory or other User Manager groups, are required to openSmartForms, Anonymous Access rights can be assigned to these people.

Anonymous Access is granted on a specific Internet Information Services (IIS) web site, application or virtual directory.SmartForms supports Anonymous Access by using the Application Pool Account user to log into K2 HostServer on the site that iscreated for these users. Either all access to K2 on this site is Anonymous from an IIS perspective or Windows or FormsAuthentication is applied.

Should the need arise to grant certain users Anonymous Access rights and other users Windows or Forms Authenticationrights, two runtime sites can be installed where one is configured for Anonymous Access and the other for Authenticated Access.

To enable Anonymous Access, perform the following steps:

1. Set IIS Authentication to ONLY anonymous authentication 2. Set appSetting ConnectAsAppPool to "true". This setting can be found in the web.config file of the runtime virtual directoryin the IIS site of SmartForms. The location is by default:C:\Program Files (x86)\K2 blackpearl\K2 smartforms Runtime

3. Comment out the <deny users="?" /> under the main <authorization> node (not those under the <location> nodes)4. Uncomment the <allow users="*" /> tag

To set Authentication access:

1. Set IIS Authentication to allow anonymous access AND either Windows or Forms authentication2. Set appSetting ConnectAsAppPool to "false"3. Uncomment the <deny users="?" /> under the main <authorization> node (not those under the <location> nodes)4. Comment out the <allow users="*" /> tag

Important Consideration

When the K2 for SharePoint feature activation is executed the virtual directories for WebDesigner and EventWeb is created under_layouts/WebDesigner/EventWeb. If Anonymous Authentication is allowed on the site level, the WebDesigner and EventWebdirectories will inherit these permissions. If the site is a Claims-based Authentication site, having Anonymous Authenticationenabled will cause issues when connecting to the K2 server. Anonymous Authentication should be set to disabled forWebDesigner and EventWeb directories in this case.




11.2 Claims-based Authentication




11.2.1 Overview

OverviewClaims-based authentication is built on Windows Identity Foundation (WIF), a framework for building claims-awareapplications that is standards-based and interoperable. Interoperability is provided through reliance on industrystandard protocols such as WS-Federation, WS-Trust, and Security Assertion Markup Language 1.1 (SAML).

In claims-based authentication, an identity provider, or security token service, responds to authentication requestsand issues SAML security tokens that include any number of claims about a user, such as a user name and groupsthe user belongs to. A relying party application receives the SAML token and uses the claims inside to decide whetherto grant the client access to the requested resource. Claims-based authentication can be used to authenticate yourorganization's internal users, external users, and users from partner organizations.

K2 relies on the configuration of a K2 user manager to provide authentication and user and group resolution foridentity stores such as Active Directory, SQL, LDAP or Custom. For more information see the User Managers topic inthe K2 blackpearl Getting Started Guide:

Getting Started - Installation and Configuration > Prerequisites > Environment Configuration > User Authenticationand Security > Introduction to User Managers K2 provides the ability for incoming claims-based authenticationthrough configuration of mappings between claims-based identity providers and K2 user managers.

Full details on Claims based authentication can be found in the K2 GettingStarted Guide online athttp://help.k2.com/en/k2blackpearlgettingstarted.aspx Installation and Configuration > Installation > IntegrationConfiguration > SharePoint > Claims-based Authentication

Claims-based authentication is supported by K2 smartforms and is combined with Claims-based authenticationconfigured on K2 blackpearl.

Claims-based Authentication need to be configured and working on the K2 blackpearl server before starting the claims configuration for K2smartforms sites

Supported

Claims-based Authentication for federated claims identities such as ADFS, Azure AD, etcThe use of a Windows Identity Foundation utility (FedUtil) to configure a SmartForms runtime site to supportfederated claims-based usersWhen the abovementioned runtime site is used in the K2 smartforms Viewer Web Part on a SharePoint 2010 site,flow-through of the claims users’ identities is managed for providers in SharePoint that are ‘trusted’. However,there is a one-to-one mapping between the identity provider and the SmartForms runtime siteWindows-based users (wrapped in claims or not) with a standard Windows authentication runtime site

Unsupported

Multiple identity providers on the same runtime siteMultiple ‘trusted’ providers configured or using a Windows or Forms-based user login where the runtime site isused in the K2 smartforms Viewer Web Part on a SharePoint 2010 siteForms-based users wrapped in claims

The following matrix explains the possible combinations for Claims between K2 blackpearl and K2 smartforms:

Supported

K2 blackpearl + Claims K2 smartforms + No Claims

K2 blackpearl + No Claims K2 smartforms + No Claims

K2 blackpearl + Claims K2 smartforms + Claims

Not Supported

K2 blackpearl + No Claims K2 smartforms + Claims




11.2.2 Configuration




11.2.2.1 Prerequisites

PrerequisitesClaims-based Authentication configured on K2 blackpearlMicrosoft .NET Framework 4.5Windows Identity Framework 3.5: Runtime:http://www.microsoft.com/en-za/download/details.aspx?id=17331ORSDK:http://www.microsoft.com/en-za/download/details.aspx?id=4451Obtain a token signing certificate from your Identity ProviderThe K2 smartforms web site must be SSL enabled (Example: https://dlx.denallix.com/runtime/)

Information Required

The following information is required before beginning the claims configuration of K2 smartforms sites. The steps thatfollow direct you on how to configure claims, but you should be aware before you begin that this information isnecessary to complete the configuration.

Identity Provider – this is the application that will be providing claims-based user authentication to K2smartforms, for example AD FS.Relying Party – the K2 Host Server is configured as the relying party for the identity provider, for example ADFS.

Identity Provider

STS WS-Federation metadata document location – this is where the identity provider posts its metadatadocument.Signing Certificate – this is the certificate used by the identity provider to sign user claims.

Relying Party

K2 smartforms Site – this is the site that will become claims-enabled. K2 smartforms configures three sites bydefault – Designer, Runtime and Workflow. Each site must be individually configured for claims-basedauthentication if desired.Application configuration location – this is the path to the K2 smartforms site web.config.Application URI – this is the URI to the K2 smartforms site that will become claims-based authenticationenabled.Federation metadata file location – this is where the K2 smartforms site will store its federation metadatadocument.






https://dlx.denallix.com/runtime/

11.2.2.2 High-level Steps

Claims-based Authentication - High-level StepsThese high-level steps are provided for those familiar with configuring claims integration. For a detailed guide, seethe Step-by-Step topic.

1. Install the Windows Identity Framework SDK 3.5 (WIF) on the K2 smartforms server2. SSL-enable the web site that hosts the K2 smartforms virtual directories3. Obtain and install the Identity Provider Certificate on the K2 server4. Configure each K2 smartforms site that needs to be claims-enabled– do this for each K2 smartforms site(Designer, Workflow, Runtime)

a. Run FedUtilb. Update Web.config for bootstrap tokens and cookie handlingc. Configure App Pools to load the user profile

5. Update K2 Host Server.exe.config -- Create claims section for each Identity Provider6. Configure K2 as Relying Party Trust for each Identity Provider - do this for each K2 smartforms site (Designer,Workflow, Runtime) that is claims-enabled




11.2.2.3 Step-by-Step




11.2.2.3.1 Step 1 - Install Windows Identity Framework SDK 3.5

Step 1 - Install the Windows Identity Framework SDK 3.5Download and install the Windows Identity Framework SDK 3.5 and Windows Identity Framework 4.5 from thefollowing link:

http://www.microsoft.com/en-us/download/details.aspx?id=4451




11.2.2.3.2 Step 2 - Create an SSL-enabled site for SmartForms

Step 2 - Create an SSL-enabled site for SmartFormsConsiderations

An existing SmartForms site (not virtual directory) can be updated to be Claims-enabled or a new SmartForms site can be created forClaims-based Authentication. Note that one site can't use both Windows Authentication and Claims Authentication.

1. Open Internet Information Services (IIS) Manager2. In this example the K2 smartforms site is used. Right click the K2 smartforms site and select Edit bindings

3. Click Add4. Select https from the Type drop down list and type a new number in the Port field.5. Select the certificate used for your site. In this example it is the *.denallix.com Certificate, which is also used for the IdentityProvider, but these two certificates do not have to be the same (and in most cases will not be the same).




11.2.2.3.3 Step 3 - Obtain and install the Identity Provider Certificate

Step 3 - Obtain and install the Identity Provider CertificateThe certificate or certificates from the identity provider must be installed in the Trusted Root Certification Authorities location on the K2server. To do this, follow these steps.

1. Export the certificate from the identity provider. For the purpose of this topic, the certificate is the Token Signing Certificate fromAD FS. To find this certificate, expand the Service node and select the Certificates sub-node. Right-click the certificate and selectView Certificate from the AD FS 2.0 Management console.

2. Select the Details tab and click the Copy to File button.




3. Walk through the Certificate Export Wizard, creating a DER encoded binary X.509 certificate file.4. Copy the .CER file to the K2 server5. Double-click the .CER file on the K2 server

6. Click the Install Certificate button on the General tab.




7. Select the Place all certificates in the following store option on the Certificate Import Wizard and choose the Trusted RootCertificate Authorities store.

8. Click OK, Next and then Finish to complete the wizard. Your identity provider signing certificate is now installed for the K2 serverto trust.




11.2.2.3.4 Step 4 - Configure each SmartForms site

Step 4 - Configure each SmartForms siteEach SmartForms site must be configured using the following steps:

A - Use the FedUtil utility to generate the metadataB - Modify the web.config files for bootstrap tokens and cookie handlingC - Modify the App Pool to load the user profile

A - Using FedUtil

1. Run the FedUtil.exe which can be found in the following location:C:\Program Files (x86)\Windows Identity Foundation SDK\v3.5\FedUtil.exe

2. On the Welcome page, configure the following items:a. Application configuration location - Browse to the required SmartForms design time installation path. Open the web.configb. Application URI - Should contain the SmartForms website URL. (Example: https://dlx.denallix.com:449/Designer/) Notethat you’ll have to do this for each SmartForms site that needs to be claims-enabled.

3. Click Next.4. Select the Use an existing STS option.5. Provide a location for example: ADFS - https://adfs.denallix.com/6. Click Test location - This will automatically generate the FederationMetadata/2007-06/FederationMetadata.xml




https://dlx.denallix.com:449/Designer/

7. Click Next.8. Configure applicable options for your environment.

9. Click Next.10. Review the available claims.




11. Click Next.12. Review the summary information and click Finish.

13. Click OK.




Repeat Step 1-13 for the following URLS if Claims-Authentication is required on the Runtime and Workflow sites of K2 smartforms:

Runtime - Example: https://dlx.denallix.com:449/Runtime/Workflow - Example: https://dlx.denallix.com:449/Workflow/

NOTE: The application configuration location paths to the web.config will differ

B - Modify the web.config files for bootstrap tokens and cookie handling

1. Update the following web.config files:a. Designer - Example: C:\Program Files (x86)\K2 blackpearl\K2 smartforms Designer\b. Workflow - Example: C:\Program Files (x86)\K2 blackpearl\K2 smartforms Designer\Workflow\c. Runtime - Example: C:\Program Files (x86)\K2 blackpearl\K2 smartforms Runtime\

2. Locate the microsoft.identityModel tag3. Replace the service tag with the following:

Copy Code

… <microsoft.identityModel> <service saveBootstrapTokens="true"> …

4. Locate the federatedAuthentication tag. Add path="/" to the cookieHandler requireSsl node. Example is shown below:

Copy Code

… <cookieHandler requireSsl="false" path="/" /> …

Consideration

If you only want certain security labels' users to return in search results, the following can be added to the Workflow site's web.config filein appsettings.

Copy Code

… <add key="DestinationSearchLabels" value="K2ADFS" /> …

This should only be used to override the default that the K2HostServer has configured. This is not a required step.

C - Modify the Application Pool to load the user profile

1. In Internet Information Service(IIS) Manager, open the Advanced Settings of the Application Pool as shown below:




https://dlx.denallix.com:449/Runtime/

https://dlx.denallix.com:449/Workflow/

2. Change the setting next to Load User Profile to True. Click OK.

Repeat this step if the SmartForms sites are configured with different Application Pools.




11.2.2.3.5 Step 5 - Update K2HostServer.exe.config

Step 5 - Update K2HostServer.exe.config - Create a claims section for each identity providerThe K2HostServer.exe.config file must contain a claim section for each identity provider. Before you can configure this, you must get thethumbprint for each from the web.config files of each virtual directory configured above (Designer, Workflow, Runtime). To do this, followthese steps:

1. Open each web.config file for each SmartForms site and copy the GUID from the following location:

Copy Code

… <issuerNameRegistrytype="Microsoft.IdentityModel.Tokens.ConfigurationBasedIssuerNameRegistry,Microsoft.IdentityModel, Version=3.5.0.0, Culture=neutral,PublicKeyToken=31bf3856ad364e35"><trustedIssuers><add thumbprint="4AE0C3A788A2B40EA90E254ACD1C8E6DC48E20C9"name="http://adfs.denallix.com/adfs/services/trust" /></trustedIssuers></issuerNameRegistry> …

2. Edit the K2HostServer.exe.config and add claims sectiona. Open the K2HostServer.exe.config file from :\Program Files (x86)\K2 blackpearl\Host Server\Binb. Copy the configuration section below and add it to the config file in the configuration section.

ExampleThe following example configuration section is for the fictitious Denallix.com claims based site on a single server with usermappings configured for Windows (Active Directory), Forms (LDAP) and a Trusted Provider (AD FS for LDAP).

Copy Code

… <sourcecode.security.claims> <issuers> <issuer name="http://adfs.denallix.com/adfs/services/trust"thumbprint="E2F26FEEF7550CE36D875A76E6748979AEFCDF40 "/> </issuers> <claimTypeMappings> <claimTypeMapping securityLabel="K2ADFS"> <identityProviderClaim originalIssuer="http://adfs.denallix.com/adfs/services/trust"claimType="http://schemas.microsoft.com/ws/2008/06/identity/claims/authenticationmethod"claimValue="http://schemas.microsoft.com/ws/2008/06/identity/authenticationmethod/windows"/> <identityClaim originalIssuer="http://adfs.denallix.com/adfs/services/trust"claimType="http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name"/> <roleClaim originalIssuer="http://adfs.denallix.com/adfs/services/trust"claimType="http://schemas.microsoft.com/ws/2008/06/identity/claims/role"/> </claimTypeMapping> </claimTypeMappings> </sourcecode.security.claims> …

c. Replace the GUID obtained from Step 1 in the configuration section. d. Replace all values as per your environment in the configuration section. The configuration section should resemble the details ofyour environment. The details of your environment can be found in the following location: C:\Program Files (x86)\K2blackpearl\K2 smartforms Designer\ and as shown below:




http://adfs.denallix.com/adfs/services/trust



http://schemas.microsoft.com/ws/2008/06/identity/claims/authenticationmethod

http://schemas.microsoft.com/ws/2008/06/identity/authenticationmethod/windows%22/


http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name%22/


http://schemas.microsoft.com/ws/2008/06/identity/claims/role%22/

3. Create a new security label pointing to the trusted LDAP provider. Follow the steps as provided in the K2 blackpearl documentation:Getting Started - Installation and Configuration > Installation > Integration Configuration > SharePoint > Claims-based Authentication> Claims Authentication Configuration. The specific configuration is available under the Claim Type Mappings section of this topic.

Consideration

If you have configured the K2 Host Server to use claims for SharePoint, your K2HostServer.exe.config as per Step 2.2 above should look likethis:

Copy Code

… <sourcecode.security.claims> <issuers> <issuer name="SharePoint Security Token Service"thumbprint="F7207335CEECFC8B70B384BA4606082CA8837091" /> <issuer name="SharePoint Security Token Service Encryption"thumbprint="E0C95B0DCC11F3C88C7F6E9C62421980BEC3991C" /> <issuer name="http://sav-pd-appsrv.pointdistro.local/adfs/services/trust"thumbprint="EFB1E5519C8E5C3EFF2ECA1EC7EC1A4C45844D35" /> </issuers> <claimTypeMappings> <claimTypeMapping securityLabel="K2FORMS"> <identityProviderClaim originalIssuer="SecurityTokenService"claimType="http://schemas.microsoft.com/sharepoint/2009/08/claims/identityprovider"claimValue="forms:LdapMembership" /> <identityClaim originalIssuer="Forms:LdapMembership"claimType="http://schemas.microsoft.com/sharepoint/2009/08/claims/userlogonname" /> <roleClaim originalIssuer="Forms:LdapRoleProvider"claimType="http://schemas.microsoft.com/ws/2008/06/identity/claims/role" /> </claimTypeMapping> <claimTypeMapping securityLabel="K2ADFS"> <identityProviderClaim originalIssuer="http://sav-pd-appsrv.pointdistro.local/adfs/services/trust"claimType="http://schemas.microsoft.com/ws/2008/06/identity/claims/authenticationmethod"claimValue="http://schemas.microsoft.com/ws/2008/06/identity/authenticationmethod/password"/> <identityClaim originalIssuer="http://sav-pd-appsrv.pointdistro.local/adfs/services/trust"claimType="http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name" /> <roleClaim originalIssuer="http://sav-pd-appsrv.pointdistro.local/adfs/services/trust"




http://sav-pd-appsrv.pointdistro.local/adfs/services/trust

http://schemas.microsoft.com/sharepoint/2009/08/claims/identityprovider

http://schemas.microsoft.com/sharepoint/2009/08/claims/userlogonname

http://schemas.microsoft.com/ws/2008/06/identity/claims/role



http://schemas.microsoft.com/ws/2008/06/identity/claims/authenticationmethod

http://schemas.microsoft.com/ws/2008/06/identity/authenticationmethod/password



http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name



claimType="http://schemas.microsoft.com/ws/2008/06/identity/claims/role" /> </claimTypeMapping> <claimTypeMapping securityLabel="K2ADFS"> <identityProviderClaim originalIssuer="SecurityTokenService"claimType="http://schemas.microsoft.com/sharepoint/2009/08/claims/identityprovider"claimValue="trusted:ADFS" /> <identityClaim originalIssuer="TrustedProvider:ADFS"claimType="http://schemas.k2.com/identity/claims/name" /> <roleClaim originalIssuer="TrustedProvider:ADFS"claimType="http://schemas.microsoft.com/ws/2008/06/identity/claims/role" /> </claimTypeMapping> <claimTypeMapping securityLabel="K2"> <identityProviderClaim originalIssuer="SecurityTokenService"claimType="http://schemas.microsoft.com/sharepoint/2009/08/claims/identityprovider"claimValue="windows" /> <identityClaim originalIssuer="Windows"claimType="http://schemas.microsoft.com/sharepoint/2009/08/claims/userlogonname" /> <roleClaim originalIssuer="Windows"claimType="http://schemas.microsoft.com/ws/2008/06/identity/claims/groupsid" /> </claimTypeMapping> </claimTypeMappings> </sourcecode.security.claims> …

Note that there are two K2ADFS sections in the above configuration section.

Yellow - The claim type mapping in the highlighted yellow section represents SmartForms

Blue - The claim type mapping in the highlighted blue section represents SharePoint

If both setups use the same users, the green and pink highlighted claim types should be the same.







http://schemas.k2.com/identity/claims/name



http://schemas.microsoft.com/sharepoint/2009/08/claims/userlogonname

http://schemas.microsoft.com/ws/2008/06/identity/claims/groupsid

11.2.2.3.6 Step 6 - Configure K2 as a Relying Party Trust for each Identity Provider generated byFedUtil

Step 6 - Configure K2 as a Relying Party Trust for each Identity Provider generated by FedUtilThe following steps are required to add a relying party to the token issuer. This must be done on each site that was configured above.

This example uses AD FS but the steps are similar for other token issuers.

1. Launch the AD FS 2.0 Management console (Start > Administrative Tools > AD FS 2.0 Management )2. Add a new Relying Party Trust

3. Click Start




4. Select Import data about the relying party from a file and click on Browse. The Federation metadata file location – this is the3 site locations as per the examples previously given: C:\Program Files (x86)\K2 blackpearl\K2 smartforms Designer\FederationMetadata\2007-06\FederationMetadata.xmlC:\Program Files (x86)\K2 blackpearl\K2 smartforms Designer\Workflow\FederationMetadata\2007-06\FederationMetadata.xmlC:\Program Files (x86)\K2 blackpearl\K2 smartforms Runtime\FederationMetadata\2007-06\FederationMetadata.xml




5. Click Next.6. Enter a display name and description.




7. Click Next.8. Select the desired option.




9. Click Next.10. Review information in tabs especially the Accepted Claims and Endpoints.




11. Click Next.12. Click Close.




13. On the Issuance Transform Rules tab, click Add Rule…




14. Select Send LDAP Attributes as Claims.




15. Click Next.16. Supply a name for the rule. Configure the required and optional claim mappings.




17. Click Finish.18. Click OK.19. Restart the K2 Host Server and open the new web site




11.2.3 Claims User Identity Flow

Claims User Identity FlowThis section explains how a claims-based user identity flows in a specific environment with the following systems configured in aparticular manner as described throughout the Claims-based Authentication topics:

SharePoint 2010 Web application using Trusted Provider claims-based authenticationK2 smartforms web application using Trusted Provider claims-based authenticationAD FS 2.0 using the LDAP attribute storeK2 blackpearl with trusted Issuer, Identity Provider, Identity and Role claim mappings

For more information on configuration, see Claims-based Authentication with K2 smartforms

Logical Flow

User requests for content and data from SmartForms and K2 will follow this flow.

1. The client sends a request to access the SmartForms site.2. IIS refuses the connection and redirects the user to the trusted claims provider for SmartForms – AD FS 2.0.3. The client sends a request for a token from AD FS 2.0.4. AD FS 2.0 returns a logon page to the client prompting users for credentials.

If the client already has a valid Kerberos ticket on the network, and AD FS 2.0 is setup for Integrated Windows Authentication, then this ticket ispresented to AD FS 2.0 in the first request, skipping steps 4-7.

5. The user provides their credentials.6. AD FS 2.0 validates the credentials with the identity store, in this case Active Directory.7. Active Directory validates the client.8. AD FS 2.0 provides a claim for access to SmartForms data.9. The client presents the claim from AD FS 2.0 to the SmartForms services.10. The SmartForms services decrypts and validates the claim, then encrypts the claim with additional SmartForms claims and

provides the claims for access to K2 data.11. The K2 server validates the claim is from a trusted issuer (the SmartForms STS) and decrypts the claim.12. The K2 server matches the identity provider in the claim to one registered in K2 configuration.13. The K2 server retrieves the K2 user manager security label and the identity claim value to construct the K2 fully qualified

name user.14. The K2 server switches the context to the K2 FQN user.15. (Optional) The K2 server accesses LOB system data via Kerberos or Pass-through Authentication using the context of the

K2 FQN user.16. (Optional) The LOB system requested data is returned to the K2 server.17. The K2 data is returned to the SmartForms services.18. The SmartForms services present the K2 FQN user with the requested information.

K2 does not implement an STS and therefore does not retain or pass-on to external LOB systems any of the claims provided with the user fromSmartForms. K2 utilizes the configured claim mappings to determine the appropriate K2 fully qualified name user. Once the K2 fully qualified username context has been determined, all processing in K2 occurs using that same user context just as it does for non-claims-based users.




11.2.4 Troubleshooting Claims Authentication Configuration

Troubleshooting Claims Authentication ConfigurationThe following errors may be encountered:

Error 1:

Problem:

You are navigating to the http site. This site has now been configured for claims.

Solution:

You need to navigate to the https site created for Claims-Authentication.

Error 2:

Problem:

This indicates that you have not imported the certificate for the Issuing Party into the certificate store for the machine your site ison. The following link might be useful:

https://confluence.atlassian.com/display/CONFKB/SharePoint+Unable+to+Connect+to+SSL-secured+Confluence

Workaround:

To bypass the certificate validation, the following entry can be added to the web.config file of the specific site.

Copy Code

… <certificateValidation certificateValidationMode="None"/> …

Example:




Error 3:

Once certificates are properly configured, the following error may appear

Problem:

This indicates that the thumbprint is likely incorrect.

Solution:

Verify the thumbprint matches in the web.config and in the K2HostServer.exe.config claims configuration section. NOTE: Restartthe K2 Host Server after these changes.

Error 4:




Problem:

This indicates that there is no Name in the relying party trust

Solution:

Map the SAM-Account-Name attribute to the Name Outgoing Claim Type as per the instructions in the Step 6.16

Error 5:

The following Java script error may be encountered in the HostServer log of a Claims-based Authentication environment:

“ProcessPacket Error, Authentication With Server Failed : ID4223: The SamlSecurityToken is rejected because theSamlAssertion.NotOnOrAfter condition is not satisfied. NotOnOrAfter”

Solution:




Resync the system time of the machine as per the following article:

http://www.richardawilson.com/2012/02/adfs-20-id4332-samlsecuritytoken-is.html

Error 6:

Problem:

There is an issue with connection pooling between K2 smartforms and K2 HostServer that produces the error displayed above.This usually happens when the session and/or token expires.

Solution:

Disable connection pooling by adding <add key="Forms.UseConnectionPooling" value="false"/> to the configSections sectionof the web.config of the Designer, Runtime and Workflow sites.

or

Extend the token lifetime of the bootstrap token to 9 hours (540 minutes) for example, which will cover a typical workingday.Execute the following commands in die Windows Powershell on the environment hosting the AD FS service to affect this:Add-PSSnapin Microsoft.Adfs.PowerShellSet-ADFSRelyingPartyTrust -Targetname "Designer" -TokenLifetime 540Set-ADFSRelyingPartyTrust -Targetname "Workflow" -TokenLifetime 540Set-ADFSRelyingPartyTrust -Targetname "Runtime" -TokenLifetime 540

Error 7:

Problem:

The Claims Authentication SAML token has expired since the last interval check. This usually happens when the session and/ortoken expires. If the page is not refreshed on a regular basis the claim expiration will expire and a message will appear.

Solution:

One way to avoid the issue is to extend the lifetime of the tokens. It is recommended to change it to 9 hours as it closely matchesa typical working day. To change the lifetime of the tokens, follow the instructions here: http://technet.microsoft.com/en-us/library/gg188586.aspx




http://www.richardawilson.com/2012/02/adfs-20-id4332-samlsecuritytoken-is.html

12 Troubleshooting




12.1 Installation




12.1.1 Troubleshoot - SharePoint Configuration Wizard not opening after installation

Troubleshoot - SharePoint Configuration Wizard not opening after installationIf the SharePoint Configuration Wizard does not open when selected after a K2 smartforms installation, the SharePoint servicesmight have been held up in memory.

The image below is an example of the error that might occur:

Fig. 1. Error in Internet Explorer

To fix this, check if the SharePoint Administration Application Pool is started by opening Internet Information Services Manager(IIS) from Start > Administrative Tools. If it's not started, click on Start in the section Manage Web Site on the right asindicated in the image below.




Fig. 2. SharePoint Central Administration Application Pool

Refresh Internet Explorer to see if the page opens. If the following error occurs, perform an IIS reset. If the problem persist,restart the machine. The memory issues should be sorted.

Fig. 3. Internet Information Services error




12.1.2 Troubleshoot - Error When Using ForeFront Threat Management Gateway

Error When Using ForeFront Threat Management GatewayWhen configuring K2 smartforms for use with ForeFront Threat Management Gateway or similar MFST product, a type500 error may occur referring to the HTTP filter blocking the request. The same issue may occur when usingExchange Outlook Web Access (OWA)

Problem

The HTTP filter is configured to block High bit characters

Solution

Ensure the HTTP filter is configured to NOT “block High bit characters”, see the following link for moreinformation:

http://support.microsoft.com/kb/837865




13 K2 smartforms Copyright and Trademark Statement

© 2008-2013 SOURCECODE TECHNOLOGY HOLDINGS, INC. ALL RIGHTS RESERVED.SOURCECODE SOFTWARE PRODUCTS ARE PROTECTED BY ONE OR MORE U.S.PATENTS. OTHER PATENTS PENDING. SOURCECODE, K2, K2 BLACKPEARL, K2BLACKPOINT AND K2 SMARTFORMS ARE REGISTERED TRADEMARKS ORTRADEMARKS OF SOURCECODE TECHNOLOGY HOLDINGS, INC. IN THE UNITEDSTATES AND/OR OTHER COUNTRIES. THE NAMES OF ACTUAL COMPANIES ANDPRODUCTS MENTIONED HEREIN MAY BE THE TRADEMARKS OF THEIR RESPECTIVEOWNERS.




1 Prerequisites and Support - K2 Communitycommunity.k2.com/pfxaw45692/attachments/pfxaw45692... ·...

Documents

Transcript of 1 Prerequisites and Support - K2 Communitycommunity.k2.com/pfxaw45692/attachments/pfxaw45692... ·...