Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction...

51
Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010 Last updated Monday, April 18, 2016

Transcript of Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction...

Page 1: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

Installation Guide:Nintex Workflow 2010 and

Nintex Forms 2010

Last updated Monday, April 18, 2016

Page 2: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

Legal NoticesFor the latest information, please see http://en-us.nintex.com/company/legal.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-i-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 3: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

Contents

Legal Notices iIntroduction 1Installation checklist 1Installation worksheet 2

Before you start 3Plan your test and production environments 3Obtain account with sufficient permissions 8Obtain Nintex license files 10Schedule deployment 11

Install Nintex products to test environment and confirm 12Install Nintex products to production environment 13Run the installers 13Deploy the solutions 16Import the license files 18Configure databases and other items 18Connect and enable Nintex Live 24Enable form-based authentication for Nintex Mobile 28Activate features in SharePoint 28

Confirm production installation 31Test Nintex functionality 31Confirm installer and configuration tasks (optional) 31Reinstate original server settings 33

Uninstall Nintex Workflow and Nintex Forms 34Troubleshoot deployment 35Identify the problem 35Issues 36

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-ii-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 4: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

IntroductionThis document provides guidance for installing the following Nintex products to yourSharePoint environment.

l Nintex Workflow 2010l Nintex Forms 2010l Nintex Live

The installation process involves planning your test and production environments,deploying to a test environment, confirming test deployment, deploying to production,and confirming production deployment.

Note: This guide is intended for brand-newinstallations of the listed products. For inform-ation on installing product updates or upgradingand migrating Nintex products, run this searchon the Nintex Connect site.

Installation checklistUse the following checklist to track your status in the installation process.

1. PlanPlan your test and production environmentsObtain account with sufficient permissionsObtain Nintex license filesSchedule deployment

2. TestDeploy the solutionsImport the license filesConfigure databases and other itemsConnect and enable Nintex LiveActivate features in SharePointConfirm installation

3. InstallDeploy the solutionsImport the license filesConfigure databases and other itemsConnect and enable Nintex LiveActivate features in SharePointConfirm installation

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-1-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 5: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

Installation worksheetUse this worksheet to record locations of files and identifiers of servers used in install-ation.

Environment (Production / Test / Other): ______________________________________

Nintex Workflow

Files, account, and server used for running installer

Installer file location

License file locationUser account forinstallation processServer for runningNintex Workflow installer

Web applicationsList each web application in the SharePoint farm that is expected to useNintex Workflow.

DatabasesNintex configuration databases:

Nintex configuration database name Failover database name Notes

Content databases:

Nintex content database name SharePoint content database name Notes

Global settings

Outbound SMTP Server

From Address

Reply to Address

Nintex Forms

Installer file location

License file locationUser account forinstallation processServer for runningNintex Forms installerNintex Forms databasename

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-2-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 6: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

Before you startBefore installing Nintex products, make sure your SharePoint environment is ready andthat all preparation is complete.

Plan your test and production environments 3

Obtain account with sufficient permissions 8

Obtain Nintex license files 10

Schedule deployment 11

Plan your test and production environmentsPlanning test and production environments involves meeting system requirements,reviewing topology considerations and best practices, setting up the topology for install-ation, and setting up the server to be used for running installers.

System requirementsFollowing are the system requirements for Nintex Workflow and Nintex Forms.

Note: Nintex Forms Enterprise Edition requiresNintex Forms 1.9.0.0 or later, in addition to anEnterprise-enabled license. For more inform-ation, see Product Update Process onNintex Connect.

Type Nintex Workflow 2010 RequirementOperatingsystem

Microsoft Windows Server 2008 or Microsoft Windows Server 2008 R2

Browserclient

To design and run Nintex workflows, use the following browserversions.

l Minimum required: Microsoft Internet Explorer 7.xl Recommended: Microsoft Internet Explorer 8 or greater

Software l Microsoft SharePoint Foundation 2010 or Microsoft SharePointServer 2010

l SQL Server 2005 SP3, SQL Server 2008, or SQL Server 2012l Nintex Forms 2010 v1.0.0.0 or higher (if using Nintex Workflowwith Nintex Forms 2010

Hardware Hard disk space is dependent on the Nintex database growth rate. Thisrate is affected by the following:

l The number of workflow instances that are executedl The number of actions in a workflow instancel The number of tasks assigned to used

Type Nintex Forms 2010 RequirementOperating system

Microsoft Windows Server 2008 or Microsoft Windows Server 2008 R2

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-3-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 7: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

Type Nintex Forms 2010 RequirementBrowserclient

To design Nintex forms, use the following browser versions.

l Minimum required: Microsoft Internet Explorer 8.xl Recommended: Microsoft Internet Explorer 10 or greater

To run Nintex forms, use the following browser versions.

l Minimum required: Microsoft Internet Explorer 7.x or latest versionof Chrome, Firefox, or Safari (Mac/iOS)

l Recommended: Microsoft Internet Explorer 10 or greater, or latestversion of Chrome, Firefox, or Safari (Mac/iOS)

Software l SQL Server 2005 SP3 or SQL Server 2008l Nintex Workflow 2010 v2.3.9.0 or higher if using Nintex Forms withNintex Workflow 2010

l Microsoft SharePoint Foundation 2010 or Microsoft SharePointServer 2010

l Microsoft .NET Framework 4.0 is required if you are using theNintex Mobile product and require communication to be sentthrough Nintex Live. Nintex Forms 2010 v1.3 and greater ships withNintex Live Relay Service and Nintex Forms Compatibility RelayService to interoperate with Nintex Mobile and Nintex Live. Theseservices must run on a server that has Microsoft .NET Framework4.0 installed. The Nintex Forms 2010 installer automaticallydeploys these services to all servers in your farm that haveMicrosoft .NET Framework 4.0 installed.

Refer to licensing details of SharePoint Server 2010 for Internet Sites(FIS) about external or anonymous users, when publishing forms toNintex Live.

Hardware

No Nintex-specific requirements

Review topology considerations and best practicesThis section provides guidance on preparing your environment for Nintex installation.

High availabilityThis section describes topology considerations and best practices related to high avail-ability of Nintex databases.

Capacity considerations

Nintex Workflow follows the same scalability and limitations as SharePoint workflows;both Nintex and SharePoint use the workflow engine inside SharePoint.

Storage space

Size your Nintex databases according to the anticipated use of Nintex workflows and thelevel of complexity in those workflows (numbers of actions and tasks).

Content databases and performance

Nintex Workflow installation involves creating Nintex content databases and mappingthem to SharePoint content databases. Nintex content databases store workflow andtask history.

For more information about database mapping for Nintex Workflow, see the followingNintex Connect article: Database Design Guide: Nintex Workflow.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-4-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 8: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

During the planning phase, determine the optimal number of Nintex content databasesfor your workflow traffic. Ensuring a sufficient number of content databases canimprove performance of the workflow engine across all site collections in the farm aswell as facilitating backup, restore, and migration.

For site collections that use workflows, scale each SharePoint content database to oneof the following levels of granularity, depending on the degree of traffic in yourenvironment: 

l Multiple web applications per SharePoint content databasel A single web application per SharePoint content databasel Multiple site collections (in a single web application) per SharePoint content data-base

l A single site collection (in a single web application) per SharePoint content data-base

For environments with high workflow traffic, we recommend using the most granularlevel: a single site collection in a single web application per SharePoint content data-base.

Following these guidelines optimizes performance by automatically distributing work-flows to corresponding content databases, thereby helping to avoid workflow time-outissues.

SharePoint and SQL Server

For high availability guidance specific to SharePoint and SQL Server, refer to Microsoftresources at msdn.microsoft.com and technet.microsoft.com, such as the followingarticles: 

l Database Mirroring and Log Shipping (SQL Server)l Build SharePoint 2010 for Redundancy and Availabilityl Performance and capacity management (SharePoint Server 2010)l SharePoint Server 2010 capacity management: Software boundaries and limitsl High Availability Solutions (SQL Server)l Workflow Scalability and Performance in Windows SharePoint Services 3.0

SecurityThis section describes topology considerations and best practices related to security ofNintex databases.

Ensuring security for SQL Server and SharePoint addresses the security needs of Nin-tex.

For security guidance specific to SharePoint and SQL Server, refer to Microsoftresources at msdn.microsoft.com and technet.microsoft.com, such as the following art-icles:

l Security planning for sites and content (SharePoint Foundation 2010)l Security Considerations for a SQL Server Installation

Backup and recoveryThis section describes topology considerations and best practices related to backup andrecovery of Nintex databases.

Database mapping

Every SharePoint content database that contains site collections using Nintex Workflowshould be mapped to a Nintex Workflow content database. The ideal number ofSharePoint content databases per Nintex Workflow content database varies by envir-onment. One-to-one mapping often serves smaller environments while others are bet-ter served by grouping SharePoint content databases by department or other function

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-5-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 9: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

and mapping each set of SharePoint content databases to a single Nintex Workflow con-tent database. For more information, see the following Nintex Connect article: DatabaseDesign Guide: Nintex Workflow.

Simultaneous backups and restores

To retain integrity of data, back up and restore the related and databases at the sametime.

For more information, see the following article: Nintex Workflow Backup and Restore.

SharePoint and SQL Server

For backup and recovery guidance specific to SharePoint and SQL Server, refer toMicrosoft resources at msdn.microsoft.com and technet.microsoft.com, such as the fol-lowing articles:

l Plan for backup and recovery (SharePoint Foundation 2010)l Back Up and Restore of SQL Server Databases

Set up topology for installationThis section provides guidance for preparing all servers in the SharePoint farm for theNintex installation process. This task involves ensuring that the required services arerunning and disabling antivirus software—on all servers in the farm.

Ensure services are runningThis section provides instructions for ensuring that the required services are running onall servers in the SharePoint farm.

Nintex Workflow installation requires that the following Microsoft Windows andSharePoint services be running.

Microsoft Windows services required:

l SharePoint 2010 Administrationl SharePoint 2010 Timer

SharePoint services required:

l Microsoft SharePoint Foundation Web Application (for Web Front End (WFE) serv-ers)

l Microsoft SharePoint Foundation Workflow Timer Service

Note: On application servers runningMicrosoft SharePoint Foundation WorkflowTimer Service, the Microsoft SharePointFoundation Web Application service can beturned off by following Microsoft’s recom-mended practices. See Microsoft article2674684. The Windows PowerShell com-mand listed in the "Resolution" section mustbe run on a Web Front End (WFE) serverthat has the Microsoft SharePoint Found-ation Web Application service running. Inaddition, we recommend running theIISRESET command and restarting theSharePoint Timer Service after running theWindows PowerShell command.

Nintex Forms installation does not require any services to be running other than thoserequired to run SharePoint.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-6-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 10: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

To ensure that required Microsoft Windows services are running on all servers in the farm

1. On each server, open the Services Microsoft Management Console (MMC) snap-in.

Note: For instructions on accessing the Ser-vices Microsoft Management Console (MMC)snap-in, see the Microsoft TechNet Libraryat http://technet.microsoft.com/en-us/lib-rary/cc772408.aspx.

2. For any required services that are not running, click Start.

To ensure that required SharePoint services are running on all servers in the farm

1. On the Central Administration Home page, click System Settings.2. Under Servers, click Manage servers in this farm.

Each server on the farm is listed, along with services running on that server.3. If required services are not running on a server, go back to the Central Admin-

istration Home page, click System Settings, and then click Manage serviceson this server under Servers.

4. On the Services on Server page, select the server from the Server list to displayits SharePoint services.

5. For any required services that are not running, click Start.

Disable antivirus softwareThe installation process for Nintex Workflow and Nintex Forms requires antivirus soft-ware to be disabled.

To disable antivirus software on all servers in the farm

1. On each server, note original settings for antivirus software.You'll need the original settings to revert after installation.

2. On each server, disable all antivirus software.

Set up server used for running installersSetting up the server used for running installers involves temporarily disabling UserAccount Control (UAC), ensuring that the application pools are started, and ensuringthat Windows PowerShell scripts can be run by the installers.

Note: The Nintex Forms installer must be runon a front end server.

Note: The installers need to be run on a singleserver in the farm only. If you plan to useNintex Live, choose a server that hostsSharePoint Central Administration. Doing soallows you to avoid extra steps when con-necting and enabling Nintex Live.

To temporarily disable User Account Control (UAC)

1. On the server that you plan to use for running the installers, from Control Panel,select Change User Account Control settings.

2. Note the original settings for User Account Control (UAC).You'll need the original settings to revert after installation.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-7-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 11: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

3. Disable User Account Control (UAC).For instructions on disabling UAC, see the following URL: http://win-dows.microsoft.com/en-us/windows/turn-user-account-control-on-off#1TC-C=windows-7

To ensure that the application pools are started

1. On a server that can access the application pools, open IIS Manager.For instructions, see http://msdn.microsoft.com/en-us/library/vstudio/bb763170(v=vs.100).aspx.

2. Expand the server and then click Application Pools.Status is indicated for each application server, such as SharePoint - 80 andSharePoint Central Administration v4.

To ensure that Windows PowerShell scripts can be run by the installers

1. On the server that you plan to use for running the installers, determine if Win-dows PowerShell script execution is set by group policy:a. Open the Local Group Policy Editor (gpedit.msc); for instructions, see

http://technet.microsoft.com/en-us/library/cc731745.aspx.b. Navigate to Local Computer Policy > Computer Configuration

> Administrative Templates > Windows Components > Windows Power-Shell.

c. Click Turn on Script Execution.d. In the Turn on Script Execution dialog box, determine if the Enabled set-

ting is grayed out (unavailable).Unavailability of this setting indicates that group policy is used.

e. Navigate to Local Computer Policy > User Configuration > AdministrativeTemplates > Windows Components > Windows PowerShell.

f. Click Turn on Script Execution.g. In the Turn on Script Execution dialog box, determine if the Enabled set-

ting is grayed out (unavailable).Unavailability of this setting indicates that group policy is used.

2. If group policy is used for script execution, ask your network administrator to doone of the following:

l Allow script execution policy to be set individually (turn off group policy forthat server).

l Set the policy to Unrestricted for the user and server to be used forinstallation.

When the ability to execute Windows PowerShell scripts is available, you can con-tinue on to the next step in setting up the topology for installation.

Obtain account with sufficient permissionsTo successfully install Nintex products, obtain a user account with sufficient per-missions.

Typical account used for Nintex installationIn most cases, the Farm Installation account (used to install SharePoint) satisfies thepermission requirements for the full installation process.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-8-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 12: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

To identify the Farm Installation account

Note: By default, the SharePoint Central Admin-istration v4 application pool is configured to runusing the Farm Installation account.

1. Open IIS Manager.For instructions, see http://msdn.microsoft.com/en-us/library/vstudio/bb763170(v=vs.100).aspx.

2. Under your server, click Application Pools.3. Select SharePoint Central Administration v4.4. Under Edit Application Pool, click Advanced Settings.

The Farm Installation account is indicated in the Identity row under ProcessModel.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-9-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 13: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

Least permissions modelInstallation and deployment of Nintex products requires an account with at least the fol-lowing permissions.

l SharePoint permissions:l Ability to modify farm properties (required to import the license file).Any user account in the Farm Administrators group has the ability to modifyfarm properties. To view members of this group, navigate to Central Admin-istration > Security > Users > Manage the farm administrators group.

l SharePoint_Shell_Access role membership for the SharePoint configurationdatabase, Central Administration database, and all SharePoint content data-bases.For instructions on provisioning this membership using Windows Power-Shell, see http://technet.microsoft.com/en-us/library/ff607596(v=o-ffice.15).aspx.

l SQL Server permissions:l Ability to create databases as well as modify permissions on databases.l A Microsoft Windows-based login to SQL Server that is a member of the fol-lowing roles:

l securityadmin fixed server rolel dbcreator fixed server rolel db_owner fixed database role for all databases in the server farm thatwill be used during installation

l Windows PowerShell permissions:l SharePoint_Shell_Access role membership (required to access parts ofSharePoint via Windows PowerShell).

l Ability to run Windows PowerShell scripts if script execution is set by grouppolicy; needed for the server on which the installers are run only. For moreinformation, see "To ensure that Windows PowerShell scripts can be run bythe installers" on page 8.

l Windows permissions:l Membership of the Administrators group for every server in the farm.To determine if a user account has local administrator rights on the server,view the Administrators group: In the Services Microsoft Management Con-sole (MMC) snap-in, expand Local Users and Groups, expand Groups, anddouble-click Administrators. If your account is not listed, note originalstatus for reverting after installation is complete, then add the account tothe group. For information about Local Users and Groups in the ServicesMicrosoft Management Console (MMC) snap-in and instructions on addingaccounts to the Administrators group, see http://msdn.microsoft.com/en-us/library/ee250492(v=bts.10).aspx.

Obtain Nintex license filesMake sure your Nintex license files are up to date. Make sure each license is explicitlyactivated for the functionality that you want, such as Nintex Forms Enterprise orNintex Live.

Note: Nintex Forms Enterprise Edition requiresan Enterprise-enabled license. For more inform-ation, see Product Update Process onNintex Connect.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-10-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 14: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

If you have questions about your license files, contact your Nintex partner or territorymanager.

Schedule deploymentTo minimize interruption of services, determine the best time for deployment to pro-duction. Follow best practices for announcing deployment.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-11-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 15: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

Install Nintex products to test environment andconfirmComplete all installation steps on a test SharePoint environment and then confirm suc-cessful installation. See "Install Nintex products to production environment" on the nextpage and "Confirm production installation" on page 31.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-12-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 16: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

Install Nintex products to production envir-onmentThis section provides guidance for installing Nintex Workflow and Nintex Forms to yourproduction environment. Installation involves running the installers, deploying theprovided Nintex solutions, importing the Nintex license files, configuring databases, con-necting and enabling Nintex Live, and activating Nintex features in SharePoint.

Run the installersRun the installer for each product being installed.

You can download the installer files from the product download page of the Nintex Con-nect site at https://community.nintex.com. For more information, contact your Nintexpartner or territory manager.

Nintex Workflow installerThis section applies to installation of Nintex Workflow. If you are not installingNintex Workflow, you can skip this section.

To install Nintex Workflow

1. Set up a server for running the installers. See "Set up server used for runninginstallers" on page 7.

2. Double-click the installer file to display the installation dialog box.Example installer file: NintexWorkflow2010Int.exe

Note: To run the installer with a useraccount other than the logged-in useraccount, press and hold SHIFT, right-clickthe installer file, select Run as differentuser, and then enter the credentials for thedesired account.

3. On the Welcome to the Installation Wizard page, click Next.4. On the License Agreement page, review the license, click I Agree, and then clickNext.

5. Nintex Live: Choose the desired option.l To install Nintex Live, select the check box for Install Nintex Live andthen click Next.

Note: Any currently installed version ofNintex Live is automatically upgradedregardless of the selected option.

Note: For more information onNintex Live, see "Connect and enableNintex Live" on page 24. For licensinginformation, see www.n-intex.com/licensing.

l To continue without installing Nintex Live, clear the check box for InstallNintex Live and then click Next.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-13-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 17: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

6. Click Yes to initiate adding the solution to SharePoint and then click Next.

Note: You can optionally select No toexport the Nintex Workflow solutions formanual deployment later. For instructionsto manually export and import solutions fordeployment, see Manually export andimport solutions.

Installation status is indicated by messages and a progress bar.7. When installation is complete, click Close to close the installation dialog box.

The installer installs Nintex-named assemblies and SharePoint features locally.For more information, see "Nintex assemblies and features" on page 31.The solutions are now available for deployment to your SharePoint farm. Forinstructions on deploying solutions, see "Steps for deploying solutions" on page17.

Nintex Forms installerThis section applies to installation of Nintex Forms. If you are not installingNintex Forms, you can skip this section.

To install Nintex Forms

Note: The Nintex Forms installer must be runon a front end server.

1. If you plan to use Nintex Forms with Nintex Workflow, make sure that theNintex Workflow solutions are already deployed to the required Web applic-ations.

2. Set up a server for running the installers. See "Set up server used for runninginstallers" on page 7.

3. Double-click the installer file to display the installation dialog box.Example installer file: NintexForms2010Int.exe

Note: To run the installer with a useraccount other than the logged-in useraccount, press and hold SHIFT, right-clickthe installer file, select Run as differentuser, and then enter the credentials for thedesired account.

4. On the Welcome to the Installation Wizard page, click Next.5. On the License Agreement page, review the license, click I Agree, and then clickNext.The Installing page appears with a description of the Nintex Live installation.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-14-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 18: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

6. Nintex Live: Choose the desired option.l To install Nintex Live, select the check box for Install Nintex Live andthen click Next.

Note: Any currently installed version ofNintex Live is automatically upgradedregardless of the selected option.

Note: For more information onNintex Live, see "Connect and enableNintex Live" on page 24. For licensinginformation, see www.n-intex.com/licensing.

l To continue without installing Nintex Live, clear the check box for InstallNintex Live and then click Next.

7. On the Confirm Installation page, click Yes to initiate adding the solution toSharePoint and then click Next.Installation status is indicated by messages and a progress bar.

Note: You can optionally select No toexport the Nintex Workflow solutions formanual deployment later. For instructionsto manually export and import solutions fordeployment, see Manually export andimport solutions.

8. When installation is complete, click Close to close the installation dialog box.The installer installs Nintex-named assemblies and SharePoint features locally.For more information, see "Nintex assemblies and features" on page 31.The solutions are now available for deployment to your SharePoint farm. Forinstructions on deploying solutions, see "Steps for deploying solutions" on page17.

Manually export and import solutionsThe following steps detail how to manually export and import Nintexsolutions.

Prerequisites: Windows PowerShell and either SharePoint 2010 Management Shell orSharePoint 2013 Management Shell must be run as administrator to import the solu-tions.

To manually export Nintex solutions

1. Run the installation wizard and navigate to:Do you want to add the solution to SharePointnow?

2. Choose No, I wish to export the solution and deploy it manually laterand then click Export.

3. Select the destination folder.Default value: Desktop.

4. Click OK.

To manually import a Nintex solution using Windows PowerShell

1. Add the Windows PowerShell snap-in to the current session by running the fol-lowing command.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-15-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 19: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

Add-PSsnapin Microsoft.SharePoint.PowerShell

2. Add the solution to the farm by running the following command.Add-SPSolution drive:\path\NameofSolution.wsp

where drive is the drive letter, path is the folder path, and NameofSolution.wspis the name of the solution.

To manually import a Nintex solution using SharePoint Management Shell

l Add the solution to the farm by running the following command.Add-SPSolution drive:\path\NameofSolution.wsp

where drive is the drive letter, path is the folder path, and NameofSolution.wsp isthe name of the solution.

Deploy the solutionsThis section provides information about the solutions (.wsp files) included with theinstallers.

Solutions and required deploymentsThis section describes the solutions (.wsp files) included with the installers and indicatesrequired Web application deployments. For instructions on deploying solutions, see"Steps for deploying solutions" on the next page.

Solution name(ordered alphabetically)

RequireddeploymentsAll CA

NintexForms2010.wsp

Nintex Forms 2010 web application-specific functionalityAuto* Auto*

NintexForms2010Core.wsp

Nintex Forms 2010 farm-wide functionalityAuto* Auto*

NintexLiveCore.wsp

Nintex LiveAuto Auto

NintexWorkflow2010.wsp

Nintex Workflow 2010 web application-specific functionalityYes Yes

NintexWorkflow2010Core.wsp

NintexWorkflow 2010 farm-wide functionality for servers with therole "Application"

Auto Auto

NintexWorkflow2010EnterpriseFeatures.wsp

Nintex Workflow 2010 - Enterprise Edition (for Enterprisereporting)

Yes Yes

NintexWorkflow2010WFECore.wsp

Nintex Workflow 2010 farm-wide functionality for servers with therole "Web Front End"

Whenrequired

No

Legend:

All: All content Web applications

CA: Central Administration Web application

Auto: Globally deployed automatically via installer.

When required: Manual deployment only, for Web Front End servers only.See "Installation error for web front end (WFE) servers: Nintex Workflow"on page 39.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-16-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 20: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

* To troubleshoot failed deployment, see "Solution packageerror: nintexforms2010core.wsp " on page 45 or other sections under"Troubleshoot deployment" on page 35.

Sequence of solution deploymentUse the following sequence when deploying your Nintex solutions.1. Nintex Workflow

a. NintexWorkflow2010core.wspb. NintexWorkflow2010.wspc. Other Nintex Workflow solutions as desired, in any sequence

2. Nintex Forms

Note: If a backwards-compatible user interfacesolution was provided for the product and youdecide to use it, deploy it after all other solu-tions for the given product.

Steps for deploying solutionsFollow these instructions to deploy Nintex solutions to your SharePoint environment.

This topic assumes that the installers have already been run and the solutions havealready been imported.

To deploy a Nintex solution

1. On the Central Administration Home page, click System Settings.2. In the Farm Management section, click Manage farm solutions.

The Solution Management page appears. Solution deployment status is indicatedin the Status column; the Web applications to which the solutions are deployedare indicated in the Deployed To column.If you manually exported the solutions, you must manually import them. Forinstructions, see Manually export and import solutions.

3. To deploy a solution to all content Web applications, do the following:

Note: Make sure you deploy the solution toall content Web applications first (ifrequired). Make sure you deployNintex Workflow solutions beforeNintex Forms solutions (if usingNintex Forms with Nintex Workflow).

a. Display the Deploy Solution page: Click the solution that you want todeploy and then click Deploy Solution.

b. In the Deploy When? section, select Now.c. In the Deploy To? section, select All content Web applications.d. Click OK.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-17-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 21: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

4. To deploy a solution to the Central Administration Web application, do the fol-lowing:a. Display the Deploy Solution page: Click the solution that you want to

deploy and then click Deploy Solution.b. In the Deploy When? section, select Now.c. In the Deploy To? section, select the URL for the Central Administration

Web application.d. Click OK.

Import the license filesFor full product functionality you must have a license file issued by Nintex for eachproduct. Each license can be either a full production license or an evaluation license.The license files must be imported into SharePoint Central Administration.

Note: Nintex Forms Enterprise Edition requiresan Enterprise-enabled license. For more inform-ation, see Product Update Process onNintex Connect.

Note: No separate license file is required forNintex Live; however, the product-specificlicense key must be explicitly activated forNintex Live.

To import each license file

1. On the Central Administration Home page, display the licensing page for yourproduct:

l For Nintex Workflow, click Nintex Workflow Management and thenclick Licensing.

l For Nintex Forms, click Nintex Forms Management and then clickLicensing.

2. On the selected licensing page, click Import.The page displays a Browse button.

3. Click Browse to locate your license file and then click Import.The licensing information is displayed.

4. Click OK.When all license files have been imported, you can proceed to configure data-bases for Nintex Workflow and Nintex Forms.

Configure databases and other itemsNintex Workflow configurationThis section provides guidance on configuration tasks for Nintex Workflow, including con-figuring databases, activating web applications, enabling workflow actions, configuringemail settings, and setting up LazyApproval.

This section applies to installation of Nintex Workflow. If you are not installingNintex Workflow, you can skip this section.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-18-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 22: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

Configure databases for Nintex WorkflowThis section provides instructions for Nintex Workflow database configuration.

Nintex Workflow requires a configuration database. While the configuration databasecan technically serve as the sole content database for Nintex Workflow, we recommendmultiple content databases to ensure high availability. For more information, see "Con-tent databases and performance" on page 4.

To set up configuration and content databases

1. Create a Nintex configuration database:a. On the Central Administration Home page, click Nintex Workflow Man-agement.

b. Click Database setup.c. In the Configuration Database section, click Create.d. On the Create configuration database page, enter the name of your data-

base server and enter a database name.

Note: The default value for DatabaseServer is the default SharePoint data-base server.

e. Click OK.A database connection string appears in the Configuration Database sec-tion.

2. Add content databases as needed to store workflow and task history (optional;see "Content databases and performance" on page 4):a. To redisplay the database setup page, on the Central Administration Home

page, click Nintex Workflow Management and then click Databasesetup.

b. For each content database to be added, do the following:i. In the Content Databases section, click Add content database.ii. In the Add content database page, enter the name of your database

server and a database name; leave all other settings as default.iii. Click OK.

A database connection string appears in the Configuration Data-base section.

3. Map Nintex content databases to SharePoint content databases:a. To redisplay the database setup page, on the Central Administration Home

page, click Nintex Workflow Management and then click Databasesetup.

b. Click Manage database mappings.c. For each SharePoint content database corresponding to a site collection

that uses Nintex Workflow, select a Nintex Workflow content databaseunder Map to Workflow Content Database.For more information about database mapping for Nintex Workflow, seethe following Nintex Connect article: Database Design Guide: Nintex Work-flow.

d. Click OK.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-19-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 23: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

4. Run the IISreset command to implement the changes:a. Start a command prompt as an administrator.

For instructions, see the following TechNet article: http://-technet.microsoft.com/en-us/library/cc947813(v=WS.10).aspx

b. Enter the following command.IISreset

Activate the web applicationsNintex Workflow requires activation of web applications that will use the product.

To activate the web applications

1. On the Central Administration Home page, click Nintex Workflow Man-agement.

2. ClickWeb Application activation.The default web application name is automatically selected.

3. To activate all web applications for Nintex Workflow, select the check box for Allcontent web applications and then click Activate.

4. To activate a subset of web applications for Nintex Workflow, select each webapplication and then click Activate; repeat until all desired web applicationshave been activated.

Enable actions for Nintex WorkflowThis section provides instructions for enabling Nintex Workflow actions. Only the actionsyou enable are displayed in the Workflow designer.

To enable Nintex workflow actions

1. On the Central Administration Home page, click Nintex Workflow Man-agement.

2. Click Manage allowed actions.By default, for new installations, no actions are selected.

3. Click the check box in the heading row to enable all actions.Alternatively, to enable a subset of the available actions, select the check box foreach desired action.Enabled actions become available in the Workflow designer.

4. Click OK.The web.config file for each web application is updated to list enabled actions assafe controls.

Configure SharePoint email prerequisitesThis section provides instructions for completing SharePoint email settings that arerequired for using LazyApproval and sending email from Nintex workflows. SharePointemail settings include configuring incoming email, confirming that required services arerunning, and ensuring that incoming emails are sent to the correct servers.

To configure incoming email for the farm

l See the following Microsoft article: Configure incoming email for a SharePoint2013 farm.SharePoint automatically populates the incoming email address for the farm usingthe fully qualified domain of the server. To view or edit this address, go to the Cen-tral Administration Home page, click System Settings, and then click ConfigureIncoming E-mail Settings.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-20-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 24: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

To confirm that required services are running

l On each server in your farm that is running the service Microsoft SharePointFoundation Incoming E-Mail, do the following: 

For thisservice...

Do this to confirm that the service is running:

MicrosoftSharePointFoundationIncoming E-Mail

On the Central Administration Home page, click Manageservers on this farm (under System Settings).

MicrosoftSharePointFoundation WebApplication

On the Central Administration Home page, click Manageservers on this farm (under System Settings).

SMTP Reference the "Install and configure the SMTPservice" section of the following Microsoftarticle: Configure incoming email for a SharePoint 2013farm.

To ensure that incoming emails are sent to the correct servers (environments with multiplefront-end servers)

l Configure your load balancer to forward incoming emails to servers with theSMTP service enabled. Refer to your organization's SharePoint environment doc-umentation.

Configure Nintex Workflow email settingsThis section provides instructions to configure email settings for Nintex Workflow.

To configure email settings for Nintex Workflow

1. Ensure that the SharePoint email prerequisites are met.For more information, see "Configure SharePoint email prerequisites" on the pre-vious page.

2. On the Central Administration Home page, click Nintex Workflow Man-agement.

3. Click Global settings.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-21-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 25: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

4. Under Email settings, enter the following details.l Outbound SMTP ServerEnter the URL used for outgoing mail in your SharePoint farm.Example: exchange.example.com

l From AddressExample: [email protected]

l Reply To AddressExample: [email protected]

Note: When using LazyApproval, theReply To Address must be identical tothe alias specified on the LazyApprovalsettings page. If you would like theworkflow-triggered emails to display anemail address other than the configuredLazyApproval account, then specify thedifferent email address in FromAddress. Make sure that Reply ToAddress is the LazyApproval alias. Thisway the email sender can be identifiedas a portal email address, such [email protected], while replies aresent to the LazyApproval alias, such [email protected].

5. Edit other settings on the page as needed for your environment.6. Click OK.

Set up LazyApprovalLazyApproval allows users to respond to requests in real language, even when on the goand without access to the SharePoint portal.

Setting up LazyApproval involves enabling LazyApproval for the server farm, con-figuring the LazyApproval alias for email, and optionally editing phrases recognized andignored by the LazyApproval process.

To set up LazyApproval

1. Ensure that SharePoint email prerequisites and Nintex Workflow email settingsare configured.For more information, see "Configure SharePoint email prerequisites" on page 20and "Configure Nintex Workflow email settings" on the previous page.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-22-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 26: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

2. Go to the LazyApproval Settings page:a. On the Central Administration Home page, click Nintex Workflow Man-agement.

b. Click LazyApproval settings.c. Click Enable / Disable LazyApproval for the current server farm.

Note: The page displays a message ifeither of the following requirements ismissing: email configuration forNintex Workflow and incoming emailfor the farm. For more information, see"Configure SharePoint email pre-requisites" on page 20 and "ConfigureNintex Workflow email settings" onpage 21.

3. Under Enable LazyApproval via email, select Yes.4. In the Email alias text box, enter a unique account name.

The alias is the name that will be used as the email address that sends the noti-fications and accepts the LazyApproval replies. The domain is determined by theincoming email address for the farm. To view or edit this address, go to the Cen-tral Administration Home page, click System Settings, and then click ConfigureIncoming E-mail Settings.Example: [email protected]

Note: Ensure that the email alias complieswith standard SharePoint requirements foremail-enabled document libraries and lists.For example, the email alias cannot havean inbox in Exchange as having one pre-vents transmission to SMTP.

Note: Contacts in Active Directory are notrequired. There is no need for DirectoryManagement Service.

5. Click OK to save changes.

Note: If the Reply To Address setting underNintex Workflow > Global settings differsfrom the Alias setting, then Nintex updatesthe Reply To Address setting to match theAlias setting. These email settings must beidentical for LazyApproval to function.

The changes propagate to all servers within about 15 minutes.A list of phrases recognized and ignored by the LazyApproval process appears.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-23-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 27: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

6. Add, edit, or remove phrases at your discretion.l To add a recognized phrase, click Create a new LazyApproval term forthe current server farm and enter the desired phrase and outcome.

l To edit a recognized phrase, click the phrase, then change settings in theEdit LazyApproval Phrase page.

l To remove a recognized phrase, click the phrase, then click Delete in theEdit LazyApproval Phrase page.

l To add an ignored phrase, click Create a term to ignore and enter thedesired phrase.

l To remove an ignored phrase, click the Delete icon next to the phrase.The changes propagate to all servers within about 15 minutes.

7. (Optional) To implement changes immediately, run the IISreset command.

Nintex Forms configurationThis section applies to installation of Nintex Forms. If you are not installingNintex Forms, you can skip this section.

Configuring settings for Nintex Forms involves creating the database and activating fea-tures on the relevant web applications. The Nintex Forms database stores Nintex Formsconfiguration and application settings.

To create the database for Nintex Forms

Note: The Nintex Forms database is required.

1. On the Central Administration Home page, click Nintex Forms Management.2. Click Manage database.

When Nintex Forms is newly installed, the Manage Database page displaysdefault settings for the Nintex Forms database.

3. If needed, edit the database settings.4. Click OK to create the database.

To activate Nintex Forms on a web application

1. On the Central Administration Home page, click Application Management.2. In the Web Applications section, click Manage web applications.3. In the Name column, select the web application on which you want to activate

Nintex Forms.For example, select SharePoint -80.

4. In the Web Applications ribbon, click Manage Features.The Manage Web Application Features dialog box appears.

5. In the Nintex Forms section, click Activate.After a short delay, the dialog box refreshes and the status is "Active."

6. Click OK.

Connect and enable Nintex LiveThis section applies to installation of Nintex Live. If you are not installing Nintex Live,you can skip this section.

Connecting and enabling Nintex Live involves establishing a connection to Nintex Live,enabling Nintex Live for Nintex Workflow and Nintex Forms, registering the SharePointfarm, and optionally changing the managed user account that runs the Nintex Live ser-vices.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-24-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 28: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

Following are the features requiring enabling for Nintex Live: 

l Nintex Live for Nintex Workflow: Allows users to add web services from theNintex Live Catalog to the Nintex workflow actions toolbox.

l Nintex Live Forms: Allows form designers to make designated forms available tointernet users via Nintex Live, with anonymous or secure access via third-partyauthentication providers.

To connect and enable Nintex Live

1. If Nintex Live was not installed from the installer, manually install and deploy it. The Nintex Live solution is named nintexlivecore.wsp; you must also import allcertificates from the “Certs” folder. This solution and its certificates are locatedin the installation folder for Nintex Workflow and for Nintex Forms when the rel-evant option is selected from the installer, causing the solution to be exported forlater deployment.

2. If Nintex Live was installed on a machine that does not host SharePoint CentralAdministration, run the following command: a. Log on to the server hosting SharePoint Central Administration.b. Open a SharePoint PowerShell command prompt and run the following

command:install-liveservice

3. Make sure the certificates used by Nintex Live are available.a. On the Central Administration Home page, select Security.b. In the General Security section, click Manage trust.c. Review availability of the following certificates; if any are unavailable,

update to make them available.l Baltimore CyberTrust Root.crtl GTE CyberTrust Global Root.cerl Microsoft Internet Authority.cerl Microsoft Secure Server Authority.cerl Thawte Primary Root CA.cerl Thawte SSL CA.cer

4. Enable Nintex Live for Nintex Workflow.a. On the Central Administration Home page, select Nintex Workflow Man-agement.

b. Click Live settings.c. In the Enable Nintex Live for Nintex Workflow section, click Enable and

then click OK.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-25-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 29: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

5. Enable Nintex Live for Nintex Forms.a. On the Central Administration Home page, select Nintex Forms Man-agement.

b. Click Live Forms settings.c. In the Enable Nintex Live Forms section, click Enable.d. To allow Live Forms to be submitted by anonymous users over the Inter-

net, in the Allow anonymous form submissions section, select Yes, andthen confirm the action.

Note: Allowing anonymous form sub-missions may require Microsoft serverinternet licensing.

6. Establish a connection to Nintex Live.The Nintex Live Framework (installed with Nintex Live) requires a connection tothe internet to communicate with Nintex Live.a. On the Central Administration Home page, select Nintex Live Man-agement.

b. Click Health Checks.If the connection to Nintex Live can be established, a "Success" messageis displayed in the status column.

Note: If your network requires a proxyserver to access the internet, specifythe server details in the Proxy serversection. These settings are specific tothe Nintex Live Framework and will bethe only application allowed access tothe internet.

7. Confirm that the server can access the Nintex Live URLs: From the server run-ning the Nintex Live services, navigate to each of the following URLs.

l https://live.nintex.coml https://liveservices.nintex.coml https://nintexlive.blob.core.windows.net/serviceiconl https://nintexrelay.servicebus.windows.netl https://cm.nintex.com (to connect to Connection Manager)

Nintex Live Relay Service accesses these URLs for both Nintex Workflow andNintex Forms.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-26-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 30: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

8. Nintex Forms: Register the SharePoint farm for Nintex Live for Mobile Access.a. If you have a firewall in place, make the following ports accessible using

outbound rules (the ports will be used by Nintex Live Relay Service).l 9351/HTTPl 80/HTTPl 443/HTTP

b. On the Central Administration Home page, click Application Man-agement.

c. In the Service Applications section, click Manage services on server.d. Click Start for Nintex Live Relay Service.e. Click Nintex Forms Management and then click Manage Live MobileAccess.

f. Click Enable.9. Nintex Forms: Change the managed user account that runs the Nintex Live ser-

vices (optional).

Note: Nintex Forms 2010: The option tochange this user account is available inv.1.1.2 and greater. Applicable services:Nintex Live Relay Service and Nintex LiveCompatibility Relay Service.

a. Obtain a managed user account with the following access and group mem-berships:

l Appropriate access to the Nintex Forms and Nintex Workflow data-bases

l Access to the SharePoint lists and web applications that may beused by the Live service

l Membership in the Farm Administration group on the SharePointfarm

b. On the Central Administration Home page, click Security.c. Change the user account for Nintex Live Relay Service:

i. In the General Security section, click Configure serviceaccounts to display the Service Accounts page.

ii. In the first drop-down menu, selectWindows Service – NintexLive Relay Service.

iii. From the Select an account for this component drop-downmenu, select the appropriate user account.

iv. Click OK.d. Change the user account for Nintex Live Compatibility Relay Service

(optional): i. Redisplay the Service Accounts page.ii. In the first drop-down menu, selectWindows Service – NintexForms Compatibility Relay Service.

iii. From the Select an account for this component drop-downmenu, select the appropriate user account.

iv. Click OK.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-27-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 31: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

10. Confirm the ability to register SharePoint accounts with Nintex Live.a. Follow the instructions from Nintex Live registration in the Nintex Mobile

help to register a SharePoint account with Nintex live.If the registration wizard is not displayed, see "Registration error:Nintex Live" on page 42.

b. (Optional.) Confirm that the registered user is listed on the server hostingSharePoint Central Administration: From the Central Administration Homepage, click Nintex Forms Management and then click Manage LiveMobile Users.

c. On a mobile device, sign in to the Nintex Mobile app using the Microsoftaccount selected for Nintex Live registration.

Enable form-based authentication for Nintex MobileForm-based authentication (FBA) authenticates Nintex Mobile users through a webapplication sign-in page instead of the app sign-in screen. For more information aboutFBA for Nintex Mobile, see the help.

To enable FBA access to Nintex Mobile for the SharePoint farm

1.On the Central Administration Home page, click Nintex Forms Management.2.Click Manage FBA Mobile Access.3.Select Enable FBA.4.To change the token expiration period, select the desired value for Set NintexMobile Token Expiry.

5.Click OK.

Note: If your network infrastructure uses afirewall, ensure that FBA endpoints are extern-ally accessible by Nintex Mobile. FBA end-points are located at the following URL:<SiteUrl>/_vti_bin/NintexMobile/FBA/

Activate features in SharePointNintex Workflow must be activated on both the site collection and relevant sites;Nintex Forms needs activation on the site collection only.

To activate features on each relevant site collection in your SharePoint environment

1. From your top site level home page, access Site Settings.2. In the Site Collection Administration section, click Site collection features.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-28-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 32: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

3. Nintex Workflow: For each feature listed, in the sequence listed, click Activateto activate.a. Activate Nintex Workflow 2010.

This feature allows SharePoint lists and libraries in this site collection toutilize Nintex Workflow features.After a short delay, the page refreshes and the feature status becomes“Active.”

b. Activate each additional feature desired.

Feature (listed inalphabetical order)

Description

Nintex Workflow 2010InfoPath Forms

Allows Nintex Workflow to use startforms and task forms designed withMicrosoft InfoPath 2013 or MicrosoftInfoPath 2010.

Nintex Workflow 2010Reporting Web Parts

Note: Thisfeature isonlyavailable fortheEnterpriseedition ofNintex Workflow.

Allows the Nintex Workflow Enterprisereporting web parts to be added to sitesin this site collection.

Nintex Workflow 2010Web Parts

Allows the Nintex Workflow web partsto be added to sites in this sitecollection.

c. If using Nintex Live, activate Nintex Workflow - Nintex Live Catalog.This feature allows Nintex Workflow designers to browse the Nintex LiveCatalog.

Note: This feature is only available ifNintex Live was installed and deployed.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-29-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 33: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

4. Nintex Forms: For each feature listed, in the sequence listed, click Activate toactivate.a. Activate Nintex Forms Prerequisites Feature.

This feature allows SharePoint lists and libraries in this site collection toutilize Nintex Forms features.After a short delay, the page refreshes and the feature status becomes“Active.”

b. Activate each additional feature desired.

Feature (listed inalphabetical order)

Description

Nintex Forms for NintexWorkflow

Allows Nintex Workflow in this sitecollection to utilize Nintex Formsfeatures.

Nintex Forms 2010 forSharePoint List Forms

Allows SharePoint lists and libraries inthis site collection to utilizeNintex Forms features.

Nintex Live Forms Allows Nintex Forms designers topublish forms to Nintex Live

Nintex Forms features are now ready to use on all sites in the site col-lection; Nintex Workflow features require activation in each relevant sitein the site collection.

To activate features on each relevant site in your SharePoint environment (Nintex Workflowonly)

This section applies to installation of Nintex Workflow. If you are not installingNintex Workflow, you can skip this section.1. From your top site level home page, access Site Settings.2. In the Site Actions section, click Manage site features.3. On the Site Features page, for each desired feature, click Activate. 

Feature (listed in alphabeticalorder)

Functionality

Nintex Workflow 2010 Nintex WorkflowNintex Workflow 2010 EnterpriseReporting

Note: This featureis only availablefor the Enterpriseedition ofNintex Workflow.

Nintex Workflow Enterprisereporting

After a short delay for each feature activation, the page refreshes and the fea-ture status becomes “Active.”Nintex Workflow features are now ready to use on the site.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-30-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 34: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

Confirm production installationThis section provides guidance on confirming successful installation of Nintex products.This confirmation involves testing Nintex functionality, confirming that installer and con-figuration tasks were completed, and reinstating original server settings.

Test Nintex functionalityMake sure you test functionality for Nintex on each SharePoint list and library expectedto use Nintex Workflow or Nintex Forms.

To test functionality for Nintex Workflow (SharePoint document library)

l Select the Library tab from the ribbon, clickWorkflow Settings, and then selectNintex Workflow to display the Nintex Workflow designer; add workflow actionsand publish.

To test functionality for Nintex Workflow (SharePoint list)

l Select the List tab from the List Tools ribbon , clickWorkflow Settings, and thenselect Nintex Workflow to display the Nintex Workflow designer; add workflowactions and publish.

To test functionality for Nintex Forms (SharePoint list only)

l Select the List tab from the List Tools ribbon and then click Nintex Forms to dis-play configuration options for the default Nintex form.

Confirm installer and configuration tasks (optional)As part of confirming successful installation, you can confirm that expected installer andconfiguration tasks were completed. Following is a summary of these tasks.

l Nintex assemblies and featuresl Solution deploymentsl Licensingl Databasesl Enabled actions (safe controls)

Nintex assemblies and featuresAs part of confirming installation, you can check for Nintex-named assemblies andSharePoint features. The Nintex installers install assemblies and SharePoint features loc-ally.

Assemblies are installed into the Global Assembly Cache (GAC). Both .NET Framework3.5 and .NET Framework 4.0 assemblies are installed.

SharePoint features are installed into the SharePoint 2010 hive.

Solution deploymentsDuring installation, the Nintex solutions need to be deployed to all required Web applic-ations. For more information, see "Steps for deploying solutions" on page 17.

To view deployment status for solutions in the farm

1. On the Central Administration Home page, click System Settings.2. In the Farm Management section, click Manage farm solutions.

The Solution Management page appears. Solution deployment status is indicatedin the Status column; the Web applications to which the solutions are deployedare indicated in the Deployed To column.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-31-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 35: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

LicensingDuring installation, the license files for installed products need to be imported intoSharePoint Central Administration as indicated in "Import the license files" on page 18.

To view imported license files

l On the Central Administration Home page, click the option for your product (Nin-tex Workflow Management or Nintex Forms Management) and then clickLicensing.

l For Nintex Live, click Nintex Live Management and then click Health checks. 

DatabasesSuccessful installation of Nintex Workflow requires that a configuration database existas well as any additional Nintex content databases needed for your environment; all Nin-tex content databases must be mapped to the corresponding SharePoint content data-bases. For more information, see "Content databases and performance" on page 4.

For Nintex Forms, confirm that the automatically created database exists. See"Nintex Forms configuration" on page 24.

In addition to ensuring that all required databases are set up, confirm that the webapplication user accounts are members of the custom database role WSS_Content_Application_Pools for all Nintex databases. This membership configuration is completedby Nintex installers; the WSS_Content_Application_Pools database role has all requiredSELECT and EXECUTE rights to the database required for Nintex functionality.

To confirm database role memberships for web application user accounts

1. Identify the names of all web applications used by Nintex.a. On the Central Administration Home page, click Application Man-agement.

b. In the Web Applications section, click Manage web applications.Example name of web application: SharePoint - 80

2. Identify the user account for each web application.a. On the Central Administration Home page, click Security.b. In the General Security section, click Configure service accounts.c. In the Service Accounts page, select the web application name identified

in the previous step.

Note: The web application name is pre-fixed by the phrase "Web ApplicationPool." Example: Web Application Pool - SharePoint -80

The user account for the web application is identified under Select anaccount for this component.Example user account: NINTEXTEST/PM13-SPWebApp01

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-32-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 36: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

3. View the database role membership for each user account on all Nintex data-bases.a. View the login user accounts for the database server containing the Nintex

databases: In Microsoft SQL Server Management Studio, expand the data-base server folder, expand the Security folder, and then expand theLogins folder.

b. Double-click the user account identified in the previous step to display theproperties dialog box.

c. Click the User Mapping page to view the databases mapped to the loginuser account.

d. For each Nintex database:i. Confirm that the check box for the database is selected.ii. Select the database to display the database role memberships, and

then confirm that the check box forWSS_Content_Application_Pools is selected.

If the check box for the database is not selected, or if the check box forWSS_Content_Application_Pools is not selected, go ahead and selectit and then click OK.

Enabled actions (safe controls)When workflow actions are enabled in SharePoint, the web.config files for the webapplications are updated with "safe controls." 

To confirm that web.config files were updated with Nintex "safe controls"

l From IIS Manager, right-click the web application, select Explore to view its filesin Windows Explorer, and then open the web.config file in a text editor.Example excerpt from web.config file indicating enabled actions: <SafeControl Assembly="Nintex.Workflow.ServerControls, Version=1.0.0.0, Culture=neutral,PublicKeyToken=913f6bae0ca5ae12" Namespace="Nintex.Workflow.ServerControls"TypeName="*" Safe="True" />

Reinstate original server settingsWhen installation is complete, reinstate original server settings across the farm.

On the server used for running the installers, reinstate the following server settings(see "Set up server used for running installers" on page 7): 

l User Account Control: reinstate at the original levell User account rights: If you added the Farm Installation account (or other useraccount used for installation) to the Administrators group for the server on whichyou installed Nintex, remove the account from the group. Leaving the account inthe Administrators group results in report warnings from the SharePoint HealthAnalyzer.

l Group policy for script execution: reinstate if needed

On all servers in the farm, reinstate the following server settings (see "Disable antivirussoftware" on page 7): 

l Antivirus software: re-enable original programs

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-33-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 37: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

Uninstall Nintex Workflow and Nintex FormsThis section provides guidance for uninstalling Nintex Workflow and Nintex Forms.

To remove for reinstall:

l Run the IISreset command on all servers in the farm to ensure that Nintex assem-blies are not write-locked. Make sure you run this command after a failed install-ation of the installer package.

l Retract and remove Nintex solutions from the farm, first for content web applic-ations, and then for Central Administration. For retraction and removal instruc-tions, refer to the following MSDN article: http://msdn.microsoft.com/en-us/library/office/aa543958(v=office.14).aspx.

To remove completely (no reinstall intended): 

l Remove all Nintex entries from the relevant web.config files. For more inform-ation, see "Enabled actions (safe controls)" on the previous page.

l Remove all Nintex assemblies. For more information, see "Nintex assemblies andfeatures" on page 31.For more detailed guidance on complete removal of Nintex Workflow andNintex Forms, see the following uninstall documents on Nintex Connect.Uninstall Nintex Workflow 2010Uninstall Nintex Forms 2010

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-34-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 38: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

Troubleshoot deploymentThis section describes ways to narrow down deployment problems as well as resolutionsfor deployment issues that may come up.

Identify the problemThis section describes methods for narrowing down problems with solution deployment.

Deploy test solution packagesDeployment issues with the Nintex Workflow solution package (nin-texworkflow2010.wsp) may indicate an issue with the SharePoint environment. If yoususpect issues with the SharePoint environment, you can deploy test solution packagesto determine if the deployment issues persist.

The following test solution packages are available from Nintex: 

l TestingSolutionGlobal.zip: This solution deploys globally; no URL needs to be spe-cified. The solution creates the following file:C:\Program Files\Common Files\Microsoft Shared\Web Server Exten-sions\14\TEMPLATE\TestingSolutionGlobal.txtIf Solution 1 does deploy correctly, then please try Solution 2 as well, which isslightly more advanced.

l TestingSolutionForWebApps.zip: This solution requires selection of a web applic-ation. The solution creates the following file:C:\Program Files\Common Files\Microsoft Shared\Web Server Exten-sions\14\TEMPLATE\TestingSolutionForWebApps.txtThe solution also deploys a file called SimpleSolution.dll to the GAC and adds anentry to the web.config file for the web application as follows:<SafeControl Assembly="SimpleSolution, Version=1.0.0.0, Culture=neutral, PublicKeyToken-n=a10b52b9b77b11de" Namespace="SimpleSolution" TypeName="*" Safe="True" />

Note: The SimpleSolution.dll contains nocode that executes.

To deploy test solution packages

1. Download the test solution packages from the following URLs: http://download.nintex.com/sl/supportfiles/TestingSolutionGlobal.ziphttp://download.nintex.com/sl/supportfiles/TestingSolutionForWebApps.zip

2. Run the following command to add the solutions to the solution store:stsadm.exe -o addsolution -filename <path to wsp file>

For a mapping of Stsadm operations and their equivalent Windows PowerShellcmdlets, see the following Microsoft TechNet article: http://-technet.microsoft.com/en-us/library/ff621081.aspx

3. Deploy the test solution packages from Central Administration. For instructions,see "Steps for deploying solutions" on page 17.If deployment does not successfully complete with one or more of the test solu-tion packages, the SharePoint environment may have an issue. We suggest con-tacting Microsoft for additional support with your SharePoint environment.If deployment successfully completes with both test solution packages, contactNintex Support.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-35-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 39: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

Review SharePoint ULS log filesThe SharePoint Unified Logging Service (ULS) log files may contain helpful informationfor troubleshooting issues with deployment of solution packages.

For example, the following error suggests a critical timer job error related to internalSharePoint problems persisting objects to the database. These errors also mention an"update conflict" as experienced when attempting solution deployment. This underlyingissue may be preventing solution deployment and should thus be resolved. ContactMicrosoft for additional support if presented with this error.

“The Execute method of job definition Microsoft.Of-fice.Server.Search.Administration.IndexingScheduleJobDefinition (ID xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) threw an exception. More information isincluded below. An update conflict has occurred, and you must re-try this action.The object IndexingScheduleJobDefinition Name=Indexing Schedule Manager onservername Parent=SearchService Name=OSearch is being updated byDOMAIN\username, in the OWSTIMER process, on machine SERVERNAME. Viewthe tracing log for more information about the conflict."

By default, ULS logs are located in the SharePoint hive. For example, the default loc-ation for SharePoint 2010 ULS logs is %ProgramFiles%\Common Files\MicrosoftShared\Web Server Extensions\14\Logs.

Note: For more information about ULS logging,see the following MSDN article. http://msdn.-microsoft.com/en-us/library/office/ff595318(v=office.14).aspx.

In your review of the log files, search for logged information during the time range inwhich the solution was scheduled to be deployed.

To aggregate all log files from SharePoint servers

l Use the Merge-SPLogFile cmdlet in a SharePoint Management Shell window.

IssuesThis section provides guidance for resolving common issues related to deployment.

Installation error for "RPC server": Nintex Forms

Symptom

The error message "The RPC server is unavailable" may appear during installation ofNintex Live and Nintex Forms on a multi-server farm. This message indicates possiblefailure of Nintex solution deployment, upgrade of the Nintex Live Relay Service, orinstallation of the Nintex Live Relay Service on one or more servers in the farm.

Cause

One or more servers in the farm may not be available due to firewall or security restric-tions.

Resolution

Manually deploy Nintex solutions and install or upgrade the Nintex Live Relay Service.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-36-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 40: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

The procedure for this resolution completes the following actions: 

l Stops and restarts the Nintex Live Relay Service if already installed and startedl Attempts to install the Nintex Live Relay Services on the current server if requiredl Deploys the following solutions to SharePoint as needed: Nintex Forms,Nintex Workflow, and Nintex Live

l Performs the IISReset command on all serversl Installs the Nintex Live Service

To manually deploy Nintex solutions and install or upgrade the Nintex Live Relay Service, do thefollowing for each server

1. Obtain a user account with the following permissions and access: l Permissions to SharePoint and Microsoft Windowsl Access to SharePoint Central Administrationl Access to SharePoint Management Shelll Access to installation files for Nintex Livel As relevant, access to installation files for Nintex Workflow andNintex Forms

2. Stop the Nintex Live Relay Service if it exists and it is started.a. On the Central Administration Home page, click Application Man-agement.

b. In the Service Applications section, click Manage services on server.c. Click Stop for Nintex Live Relay Service.

Note: If Nintex Live Relay Service isnot listed, start the Services MicrosoftManagement Console (MMC) snap-inand confirm that Nintex Live Relay Ser-vice is listed there. If the service is star-ted, stop the service. For moreinformation about this snap-in, see thefollowing Microsoft TechNetarticle: http://-technet.microsoft.com/en-us/lib-rary/cc772408.aspx

3. Perform the IISReset command and restart the SharePoint Timer Service.4. Re-deploy Nintex Workflow solutions or any Nintex solutions (other than

Nintex Forms or Nintex Live solutions) that encountered errors on the initialdeployment.

5. If the Nintex Forms solution failed to deploy on the initial deployment, run the fol-lowing script by opening SharePoint Management Shell on the Central Admin-istration server.Upgrade-NFService

Note: To run this script in Windows Power-Shell, add the following line to the script.Add-PSSnapin ‘Microsoft.SharePoint.PowerShell’

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-37-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 41: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

6. If the Nintex Live Solution failed to deploy on the initial deployment, run the fol-lowing script by opening SharePoint Management Shell.Install-LiveService

Note: To run this script in Windows Power-Shell, add the following line to the script.Add-PSSnapin ‘Microsoft.SharePoint.PowerShell’

7. If the Windows Service does not exist, run the following script by openingSharePoint Management Shell.$path =

[Microsoft.SharePoint.Utilities.SPUtility]::GetVersionedGenericSetupPath("bin\Nin-texLive\Nintex.Live.RelayService.exe",15)

$serviceName = "Nintex Live Relay Service"

New-Service -Name $serviceName -BinaryPathName $path

Note: To run this script in Windows Power-Shell, add the following line to the script.Add-PSSnapin ‘Microsoft.SharePoint.PowerShell’

8. Restart the Nintex Live Relay Service:a. On the Central Administration Home page, click Application Man-agement.

b. In the Service Applications section, click Manage services on server.c. Click Start for Nintex Live Relay Service.

9. If the Nintex Live Relay Service is in a “starting” status (with no start/stop link)for a prolonged period, then complete the following steps.a. Click Monitoring and then click Review job definitions.b. Click the job “Provisioning Nintex Live Relay Service on [SERVERNAME]”

and then delete the service.c. Run the following script in Windows PowerShell.

#Uninstall and InstallSharePoint Service

Add-Type -AssemblyName "Nintex.Live.SharePoint, Version=1.0.0.0, Culture=neutral,PublicKeyToken=c52d764dcf7ec883" -ErrorAction:SilentlyContinue | out-null

[Nintex.Live.SharePoint.WindowsServices.NintexLiveRelayInstaller]::UnInstallInstance("SERVERNAMEHERE ")

[Nintex.Live.SharePoint.WindowsServices.NintexLiveRelayInstaller]::InstallInstance("SERVERNAMEHERE ")

d. Restart the Nintex Live Relay Service again.

Installation error for "RPC server": Nintex Workflow

Symptom

During installation of Nintex Live and Nintex Workflow on a multi-server farm the fol-lowing error message appears:

"The RPC server is unavailable"

This message may indicate upgrade or installation issues on one or more servers in thefarm for one or more of the following services:

Nintex Live Workflow Queue Service

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-38-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 42: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

Cause

Possible causes for this error include firewall and security restrictions for affected serv-ers.

Resolution

Manually install or upgrade the Nintex Live Workflow Queue Service on each server inthe farm using the following procedure.1. In SharePoint Management Shell, run the following script for the

Nintex Live Workflow Queue Service:$path =

[Microsoft.SharePoint.Utilities.SPUtility]::GetVersionedSetupPath("bin\Nin-texWorkflow\Nintex.Workflow.Live.QueueService.exe")

$serviceName = "Nintex Live Workflow Queue Service"

New-Service -Name $serviceName -DisplayName $serviceName -BinaryPathName $path

2. Run the IISReset command and restart the SharePoint Timer Service.3. To start the service on the current server, do the following:

a. On the Central Administration Home page, click Application Man-agement.

b. In the Service Applications section, click Manage services on server.c. On the Services on Server page, select the desired server.d. Click Start for Nintex Live Workflow Queue Service.

Installation error for web front end (WFE) servers: Nintex Workflow

Symptom

The following message appears when installation is complete for Nintex Workflow.

Found Server(s) with ‘Web Front End’ Server Role:

[server-name]

Manual deployment of NintexWorkflow2010WfeCore.wsp solution on each listed WFEserver is required.

where [server-name] is a server detected to have the Web Front End server role

Cause

The installer could not deploy the solution to the indicated WFE servers.

Resolution

Manually deploy the version-specific solution on each WFE server using the PowerShellscript InstallWfeCoreLocal.ps1. Instructions follow.1. Record the names of the WFE servers indicated in the installer message.

Note: You can rerun the installer to viewthe message again.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-39-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 43: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

2. Export the solutions from the installer by rerunning the installer and selecting theexport option.a. Double-click the installer file to display the installation dialog box.b. On the Welcome to the Installation Wizard page, click Next.c. On the License Agreement page, review the license, click I Agree, and

then click Next.d. For Nintex Live, choose the desired option.e. On the page “Do you want to add the solution to SharePoint now?,” selectNo, I wish to export the solution and deploy it manually later.

f. Save the exported files to a folder of your choice.3. In the folder containing the exported files, open the "Workflow" folder and copy

the following files.l InstallWfeCoreLocal.ps1l NintexWorkflow2010WfeCore.wsp

4. On each WFE server indicated in the installer message, do the following.a. Paste the copied files.b. Using PowerShell with administrative privileges, run the following file.

InstallWfeCoreLocal.ps1The script deploys the solution locally. You can confirm deployment usingCentral Administration.

LazyApproval issues occurFor help troubleshooting LazyApproval issues, see the following Nintex Connectarticle: LazyApproval Guide.

Nintex icons missing from Central Administration

Symptom

Nintex icons are missing from Central Administration.

Cause

The Central Administration feature is not activated. It's possible that theNintex Workflow or Nintex Forms solution was deployed to the front-end web serversbut not to the server hosting SharePoint Central Administration.

Resolution

To resolve this issue, deploy the Nintex Workflow and Nintex Forms solutions to the Cen-tral Administration Web application; if needed, activate the relevant Nintex featuresmanually using Stsadm commands.

To deploy the solutions to Central Administration

1. On the Central Administration Home page, click System Settings.2. In the Farm Management section, click Manage farm solutions.

The Solution Management page appears. Solution deployment status is indicatedin the Status column; the Web applications to which the solutions are deployedare indicated in the Deployed To column.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-40-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 44: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

3. Deploy the Nintex Workflow and Nintex Forms solutions to the Central Admin-istration Web application:a. Display the Deploy Solution page: Click the solution that you want to

deploy and then click Deploy Solution.b. In the Deploy When? section, select Now.c. In the Deploy To? section, select the URL for the Central Administration

Web application.d. Click OK.

To activate Nintex Workflow features on Central Administration

l Run the following command, where http://centraladminurl:port is replaced withthe URL and port for the Central Administration Web application.stsadm.exe -o activatefeature -name nintexworkflowadmin -url http://centraladminurl:port

To activate Nintex Forms features on Central Administration

l Run the following command, where http://centraladminurl:port is replaced withthe URL and port for the Central Administration Web application.stsadm.exe -o activatefeature -name NintexFormsAdminWeb -url http://centraladminurl:port

Nintex Live Workflow Queue Service failed to start

Symptom

The Nintex Live Workflow Queue Service failed to start and the following error messageappears:

"No connection could be made because the target machine actively refused it"

Cause

This message indicates a firewall issue.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-41-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 45: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

Resolution

Confirm accessibility of all required ports and Nintex Live URLs using the following pro-cedure.1. If you have a firewall in place, make the following ports accessible (the ports will

be used by Nintex Live Workflow Queue Service).l5671/TCPl5672/TCPl443/HTTP

Note: Note: Nintex uses Advanced Mes-sage Queuing Protocol (AMQP) over TCPtraffic for Service Bus brokered messaging,which requires ports 5671 and 5672 to bothbe open for AMQP communication. Bydefault, port 5671 is used by Secure AMQP.

2. Confirm that the server can access the Nintex Live URLs: From the server run-ning the Nintex Live Workflow Queue Service, navigate to each of the followingURLs.

lhttps://live.nintex.comlhttps://liveservices.nintex.comlhttps://nintexlive.blob.core.windows.net/serviceiconlhttps://nintexrelay.servicebus.windows.net/

3. To start the service on the current server, do the following:a. On the Central Administration Home page, click Application Man-agement.

b. In the Service Applications section, click Manage services on server.c. Click Start for Nintex Live Workflow Queue Service.

Nintex Live: Multiple Workflow actions run in parallel may take hours tocomplete

Symptom

Processing takes hours to complete when multiple Workflow actions are run in parallelon different servers in a SharePoint farm topology.

Cause

The Nintex Live Workflow Queue Service has been enabled on two or more servers. As aresult, the queue service generates a Live event that slows down processing times.

Resolution

Do not enable the Nintex Live Workflow Queue Service on more than one server in afarm topology.

Registration error: Nintex Live

Symptom

The following message appears when a user attempts to register with Nintex Live byclicking the SharePoint user name, selecting Nintex Mobile Apps, and then selectingRegister with Nintex Live.

"An error occurred during the registration process."

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-42-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 46: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

Cause

This error may be caused by an inability to connect to Nintex Live.

Resolution

Make sure that the SharePoint site can connect to Nintex Live.

l Confirm that Nintex Live is fully connected and enabled. For instructions, see "Con-nect and enable Nintex Live" on page 24.

l Confirm connectivity to the Nintex Live relay service bus at http://n-intexrelay.servicebus.windows.net.Follow Microsoft best practices for troubleshooting service bus connectivity. Formore information, see the Microsoft article at http://so-cial.technet.microsoft.com/wiki/contents/articles/2055.troubleshooting-con-nectivity-issues-in-the-azure-appfabric-service-bus.aspx.

l As part of troubleshooting: l Review verbose log files for the Nintex Live relay service.For instructions on enabling verbose logging and reviewing the log files, seethe related procedure below.If you find any proxy errors in the log, contact your network infrastructureteam.

l Restart the Nintex Live relay service using the procedure below.l Check for blocked IP addresses using the procedure below.l Check for any proxy or firewall rules that isolate specific IP addresses.If you find any such rules, contact your network infrastructure team.

l Retry Nintex Live registration: Click the SharePoint user name to display thecontext menu, select Nintex Mobile Apps, and then select Register withNintex Live.

To check for blocked IP addresses

1. With the help of the network administrator, trace the connections by opening theproxy and firewall servers.

2. Compare the traced connections to the known reserved addresses.See http://blogs.msdn.com/b/narahari/archive/2011/08/01/ip-range-for-win-dows-azure-platform-identifying-connectivity-issues.aspx; refer to Microsoftsites for the latest information on identifying connectivity issues with WindowsAzure.

3. If any IP addresses used by the service bus are blocked, then contact your net-work infrastructure team to resolve the situation.

To enable verbose logging for the Nintex Live Relay Service and review log files

1. In a text editor, open the relay service configuration file.By default, the file is located in the SharePoint hive, under /BIN/NintexLive. Forexample, the default location is %ProgramFiles%\Common Files\Microsoft Shared\WebServer Extensions\14\BIN\NintexLive\Nintex.Live.RelayService.exe.config.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-43-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 47: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

2. Edit the file to include the following lines, indicated by bold type.<?xml version="1.0" encoding="utf-8"?><configuration><appSettings><add key="MaximumRetryInterval" value="60" /><add key="RetryIntervalCoefficient" value="2.5" /><add key="KeepLogsForMonths" value="2" /><add key="VerboseFileLogging" value="true" /></appSettings><startup><supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.0" /></startup><system.net><defaultProxy useDefaultCredentials="true"><proxy bypassonlocal="True" usesystemdefault="True"/></defaultProxy></system.net></configuration>

3. Save your changes and close the file.4. To start verbose logging, restart the Nintex Live Relay Service.

For instructions, see the related procedure below.5. Retry Nintex Live registration: Click the SharePoint user name to display the con-

text menu, select Nintex Mobile Apps, and then select Register with NintexLive.

6. To review the log files, open the folder /BIN/NintexLive/LOGS in the SharePointhive.The default location for the Nintex Live Relay Service log files is as follows.%ProgramFiles%\Common Files\Microsoft Shared\Web Server Extensions\14\BIN\NintexLive\Logs

To restart the Nintex Live Relay Service

1. On the Central Administration Home page, click System Settings and then clickManage services on this server under Servers.

2. Click Start for Nintex Live Relay Service.

Service stuck on "starting": Nintex Live Queue Service

Symptom

The Nintex Live Workflow Queue Service is in a “starting” status (with no start/stop link)for a prolonged period.

Cause

Nintex assemblies have not been refreshed by existing processes.

Resolution

Manually refresh Nintex assemblies using the following procedure.1. Delete the provisioning job as follows:

a. On the Central Administration Home page, click Monitoring.b. Click Review job definitions.c. Click the job “Provisioning Nintex Live Workflow Queue Service on

[SERVERNAME]” and then delete the job.2. Restart the SharePoint Administration Service.3. Restart the SharePoint Timer Service.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-44-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 48: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

4. Run the IISRESET command.5. To start the service on the current server, do the following:

a. On the Central Administration Home page, click Application Man-agement.

b. In the Service Applications section, click Manage services on server.c. Click Start for Nintex Live Workflow Queue Service.

Service stuck on "starting": Nintex Live Relay Service

Symptom

Nintex Live Relay Service is stuck on "starting" in Central Administration.

Cause

A timer job failed to start the service.

Resolution

Use the following procedure to stop the service, delete the job, and restart the service.1. To manually stop the service instance on a specific server in your farm, run the

following Windows PowerShell script from the SharePoint Management Console:#List all instances of the relay service

$s = Get-SPServiceInstance | where-object { $_.Name -eq "NintexLiveRelayServiceInstance" }

2. Run the following command to stop a specific instance:Stop-SPServiceInstance -Identity <A specfic instance ID>

Results may include the following error: Stop-SPServiceInstance : An object of the type Microsoft.SharePoint.Ad-ministration.SPServiceInstanceJobDefinition named "job-service-instance-2dc2524e-46b7-43f6-a4b3-15689e014b54" already exists under the parent Microsoft.SharePoint.Ad-ministration.SPTimerService named "SPTimerV4". Rename your object or delete theexisting object.

This error indicates the need to remove a pending timer job.3. If the above error appears, then run the following script to remove the pending

timer job: $job = Get-SPTimerJob | where { $_.Name -eq "<Job name shown in error message>" }

$job.Delete()

4. Rerun the stop command in step 2.5. Restart the timer service on the server.6. Restart the Nintex Live Relay Service: 

a. Close and open Central Administration.b. On the Central Administration Home page, in the System Settings section,

click Manage services on server.c. Select Change Server from the Server drop-down list on the upper right

of the page and select the server in question.d. Click Start for Nintex Live Relay Service.

Solution package error: nintexforms2010core.wsp

Symptom

A red "error" status appears next to the nintexforms2010core.wsp solution accessedfrom Central Administration. Clicking the solution shows an error deploying to or retract-ing from a specific web application.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-45-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 49: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

Example error message: 

Some of the files failed to copy during deployment of the solution.Last Operation Details: ntx-tom-1 : Error: The copying of this file failed: bin\Nin-texLive\Nintex.Forms.Mobile.Compatibility.LiveRelay.dll.The process cannot access the file 'C:\Program Files\Common Files\MicrosoftShared\Web Server Exten-sions\14\bin\NintexLive\Nintex.Forms.Mobile.Compatibility.LiveRelay.dll'because it is being used by another process.

Cause

A process is locking a .dll file that is deployed with nintexforms2010core.wsp.

Resolution

Use the following procedure to unlock the .dll file by terminating or recycling the rel-evant process.1. For each server in your farm, stop the Nintex Live Relay Service and Nintex

Forms Compatibility Relay Service if they exist and are started.a. On the Central Administration Home page, in the System Settings section,

click Manage services on server.b. Click Stop for the following services: 

l Nintex Live Relay Servicel Nintex Forms Compatibility Relay Service

c. Select Change Server from the Server drop-down list on the upper rightof the page and select the next server on your farm; repeat step b.

d. Repeat steps b-c for each server in your farm.Alternatively, stop the services via Windows Services on each server.

2. Note the servers listed in the deployment or retraction error.a. On the Central Administration Home page, click System Settings.b. In the Farm Management section, click Manage farm solutions.c. Click the nintexforms2010core.wsp solution to display its solution prop-

erties.The reason for the failure is listed as well as which servers experiencedthe issue.

3. On the noted servers, restart the timer service.4. Restart IIS on each server listed in the deployment or retraction error.5. Retry the deployment or retraction.

If the .dll file locking issue is still preventing successful deployment or retractionof the solution, you can forcibly remove the Nintex Forms .dll files from the GACwith a tool such as GacUtil.

Solution package is listed as error: Nintex Workflow

Symptom

The Nintex Workflow solution package (nintexworkflow2010.wsp) is listed as error.

Cause

The solution may not have been deployed correctly.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-46-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 50: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

Resolution1. Confirm that the SharePoint 2010 Administration service is running. See "Ensure

services are running" on page 6.2. Run the following stsadm command:

stsadm.exe -o execadmsvcjobs

For a mapping of Stsadm operations and their equivalent Windows PowerShellcmdlets, see the following Microsoft TechNet article: http://-technet.microsoft.com/en-us/library/ff621081.aspx

3. Redeploy the solution by doing one of the following:l Click Deploy Solution button in the toolbar. For complete instructions, see"Steps for deploying solutions" on page 17.

l Run the following stsadm command:stsadm.exe -o deploysolution -n nintexworkflow2010.wsp -allcontenturls -immediate -allowgacdeployment

If the solution package is still in error, check the solution information page forpotential information about error causes. To view the solution information page,go to the Central Administration Home page, select System Settings, click Man-age farm solutions, and click the link for the solution of interest.You can also analyze the SharePoint ULS log files to determine what is causingthe failure. For more information, see "Review SharePoint ULS log files" on page36.

Solution package is stuck in deployment: Nintex Workflow

Symptom

The Nintex Workflow solution package (nintexworkflow2010.wsp) is stuck in deploy-ment.

Cause

The solution may not have been deployed correctly.

Resolution

Cancel and restart the deployment.1. Run the following stsadm command to list the job identifiers for all deployments

in progress.stsadm -o enumdeployments

For a mapping of Stsadm operations and their equivalent Windows PowerShellcmdlets, see the following Microsoft TechNet article: http://-technet.microsoft.com/en-us/library/ff621081.aspx

2. Note the job identifier for the stuck Nintex workflow deployment job.3. Cancel the deployment, using the following stsadm command:

stsadm -o canceldeployment -id "your job id string here"

The solution management page in Central Administration updates the status ofthe solution to "not deployed." You can now deploy the solution again.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-47-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010

Page 51: Nintex Workflow 2010 and Nintex Forms 2010 … · Introduction ThisdocumentprovidesguidanceforinstallingthefollowingNintexproductstoyour SharePointenvironment. l Nintex Workflow2010

4. Redeploy the solution by doing one of the following:l Click the Deploy Solution button in the toolbar. For complete instructions,see "Steps for deploying solutions" on page 17.

l Run the following stsadm command:stsadm.exe -o deploysolution -n nintexworkflow2010.wsp -allcontenturls -immediate -allowgacdeployment

If the deployment is stuck again, analyze the SharePoint ULS log files to determ-ine what is causing the failure. For more information, see "Review SharePointULS log files" on page 36.

© Copyright 2016Nintex Global Ltd. | Privacy Policy | Terms & Conditions | Cookie Preferences | Nintex Support

-48-

Installation Guide: Nintex Workflow 2010 and Nintex Forms 2010