Configure Workflow Manager SharePoint 2013

Install and Configure Workflow Manager for SharePoint 2013

In this article, we’ll explain How to Install and Configure Workflow Manager SharePoint 2013 by answering the below questions.

  1. What’re the Workflow platform types available for SharePoint Server 2013?
  2. What’re the possible scenarios to install and configure Workflow Manager for SharePoint 2013 farm?
  3. How to install and configure Workflow Manager SharePoint 2013 step by step?
  4. Important tips for configuring SharePoint Workflow Manager 2013.
Configure Workflow Manager SharePoint 2013

You might also like to read SharePoint 2016: Configure Workflow Manager.


Configure Workflow Manager SharePoint 2013


The available Workflow platform types for SharePoint Server 2013

There are three Workflow platform types for SharePoint Server 2013 as the following:

  • SharePoint 2010 Workflow
    • Installs automatically with SharePoint 2013 Products.
  • SharePoint 2013 Workflow
    • Requires SharePoint Server 2013 and Workflow Manager.
  • SharePoint 2013 Workflow – Project Server
    • Requires SharePoint Server 2013, Workflow Manager, and Project Server 2013.

The possible scenarios to install Workflow Manager in SharePoint farm

You have 4 different scenarios to install Workflow Manager in SharePoint farm as the following:

  1. Workflow Manager can be installed on a server that is part of the SharePoint 2013 farm, and the communication takes place by using HTTP.
  2. Workflow Manager can be installed on a server that is part of the SharePoint 2013 farm, and the communication takes place by using HTTPS.
  3. Workflow Manager can be installed on a server that is NOT part of the SharePoint 2013 farm, and the communication takes place by using HTTP.
  4. Workflow Manager can be installed on a server that is NOT part of the SharePoint 2013 farm, and the communication takes place by using HTTPS.

Option 4 is the preferred solution to ensure the performance and security but it’s costly.

Option 4 should be applied for building an independent Workflow Manager farm that at least should be consist of one to three servers based on organization requirements and its budget capability.


Configure Workflow Manager SharePoint 2013 step by step

In this section, we will explain How to install and configure SharePoint Workflow Manager 2013 step by step:

  1. Pre-Install Steps.
  2. Install Workflow Manager.
  3. Configure Workflow Manager.
  4. Register Workflow Manager.
  5. Test Workflow Manager.

For SharePoint 2016, Please check SharePoint 2016: Configure Workflow Manager.


Prerequisites for SharePoint Workflow Manager 2013

Before, we getting started to install and configure SharePoint Workflow Manager 2013, you should make sure and perform the following:

  • Make that the SharePoint farm is at least updated to March 2013 PU (the Service Pack 1 is recommended).
  • Make sure that the App Management Service is configured and started.
  • Make sure that the User Profile Sync Service is working properly. (it’s not mandatory but if it’s already configured, just make sure it’s healthy working.).
  • Create workflow manager service accounts and Admin groups.
  • Set SQL Server Permissions for SharePoint Workflow Manager Setup Account.
  • Add the SharePoint Workflow Manager setup account to the Local Administrator Group on the server that you will install the SharePoint Workflow Manager 2013.

Please, check how to configure the App Management service at Sorry, something went wrong App Management Shared Service Proxy is not installed in SharePoint Server 2013

Workflow Manager Services Accounts and Admin Groups

Create SharePoint Workflow Manager Services Accounts

  • Open AD server to create the below two accounts.
    • ‘wfsetup’ to setup the workflow manager.
    • ‘wfsrv’ to run the workflow manager services.
  • Create the Workflow Setup account.
Add new User in AD - Workflow Manager Services Accounts
  • Specify the Workflow Setup account details.
workflow manager setup account - Workflow Manager Services Accounts
  • Create the Workflow manager Service account.
Workflow service account - Workflow Manager Services Accounts

Create SharePoint Workflow Manager Admin Groups

  •  Create the workflow manager administrator group.
Create workflow manager administrator group
  • Set the Workflow Admin group name to “WF Admins”.
WF Admins Group - Configure Workflow Admin group name
  • Add the SharePoint Admins to WF Admins Group.
WF Admins Group Member

SQL Server Permissions for SharePoint Workflow Manager Setup Account

Steps

  • Open Management Studio > Connect.
Connect to sql
  • Below Security > Right click on Logins > New Login.
new login sql.png
  • The following dialog should be shown.
new login sql1
  • Click on Search to find the WF Setup Account.
new login sql2
  • Go to “Server Roles”, Check the “dbcreator” & “securityadmin” role.
SQL Server permission for Workflow Manager Account

Add SharePoint Workflow Manager Setup Account to the Local Administrator Group

As we earlier mentioned, we will install the Workflow Manager as a part of SharePoint Farm. therefore, you can choose whatever APP or WFE server in the SharePoint farm to install Workflow Manager on it.

Whatever you have decided to install SharePoint Workflow Manager as a part of the SharePoint farm or you will install it as an independent farm, you would need to add the Workflow Manager setup account to the local administrator group of this server during the installation and configuration process.

Steps

  • Open Server Manager > Tools > Computer Management > Local Users Ad Groups > In Administrator Group > Add WF Setup Account as Member.
Add the farm account to the local administrator group

After applying the above prerequisites list, you should now go to Install and Configure Workflow Manager SharePoint 2013.


Install SharePoint Workflow Manager 2013

In this section, we will go through the detail steps to Install SharePoint Workflow 2013 by doing the following:

Steps

  • Login to Workflow Manager Server using WF Setup Account.
  • Download the Microsoft Web Platform Installer 5 from here.
  • Open Microsoft Web Platform Installer 5 and navigate to Product Tab.
Web Platform Installer - Configure Workflow Manager For SharePoint 2013
  • In search box > Type “Workflow Manager”.
Workflow manager install - Configure Workflow Manager For SharePoint 2013
  • Press add then Click on install.
Workflow manager install - Configure Workflow Manager For SharePoint 2013
  • The following dialog should be shown > Click On I Accept.
Workflow manager install - Configure Workflow Manager For SharePoint 2013
Workflow manager install - Configure Workflow Manager For SharePoint 2013
Workflow manager install - Configure Workflow Manager For SharePoint 2013
Workflow manager install - Configure Workflow Manager For SharePoint 2013
  • Click on continue where the configuration wizard should be shown.
Workflow manager install6 - Configure Workflow Manager For SharePoint 2013
  • Close it and click finish.
Workflow manager install - Configure Workflow Manager For SharePoint 2013

Install the Service Bus Cumulative Update

  • Again, open Web Platform Installer to install the Service Bus 1.0 Cumulative Update 1.
  • In Search box type Service Bus and Click on Add > Install.
  • Click on I accept.
Service Bus CU - Install Workflow Manager for SharePoint Farm 2013
Service Bus CU - Install Workflow Manager for SharePoint Farm 2013
Service Bus CU - Install Workflow Manager for SharePoint Farm 2013
Service Bus CU - Install Workflow Manager for SharePoint Farm 2013

Install Workflow Manager Cumulative Update

  • In Search box type Workflow Manager and Click on Add > Install.
  • Click on I accept.
Install Workflow Manager Cumulative Update
Install Workflow Manager Cumulative Update
Install Workflow Manager Cumulative Update
Install Workflow Manager Cumulative Update

Configure SharePoint Workflow Manager 2013

  • Login to Workflow Manager Server using WF Setup Account.
  • From Start menu > Type Workflow Manager Configuration.
Workflow Manager Configuration
  • The following dialog should be shown > Select Configure Workflow Manager with Custom Settings.
Configure workflow with custom settings - Install and Configure Workflow Manager for SharePoint 2013
  • Configure Farm Management Database as shown below > Click on Test Connection.
Configure Farm Management Database - Install and Configure Workflow Manager for SharePoint 2013
  • Configure Instance Management Database as shown below > Click on Test Connection.
Configure Instance Management Database -  Configure Workflow Manager for SharePoint 2013
  • Configure Resource Management Database as shown below > Click on Test Connection.
Configure Resource Management Database - Configure Workflow Manager for SharePoint 2013
  • Configure Service Account (domain\wfsrv).
Configure WF Service Account -  Configure Workflow Manager for SharePoint 2013
  • Configure Certificates.
    • If you don’t have certificates check auto-generate and set the generation key as SharePoint Pass-phrase.(if you have a certificate uncheck auto-generate and click browse to choose it).
Configure WF Certificate -  Configure Workflow Manager for SharePoint 2013
  • Configure Ports (Note: the assigned ports in this step are the same ports that will be used during registering workflow manager via Register-SPworkflowservice cmdlet. for more details checks Register-SPworkflowservice )
    • Let the default ports for Http/https.
    • Check to allow workflow management over HTTP on this computer.
Configure WF Ports - Configure Workflow Manager for SharePoint 2013
  • Configure Admins Group and click Next.
    • Set the admins group that you have created in the pre-install step.
Configure WF admin Group - Configure Workflow Manager for SharePoint 2013
  • Test connection to configure Service Bus.
Service bus config - Configure Workflow Manager for SharePoint 2013
  • Use the same configuration of Workflow Manager for Service Bus > Click on Next.
Service bus configuration - Configure Workflow Manager for SharePoint 2013
Service bus config - Configure Workflow Manager for SharePoint 2013
  • Review the Summary >  Click on the True button.
WF summery - Configure Workflow Manager for SharePoint 2013
  • The Configuration Progress would be starting now.
WF Config Progress - Configure Workflow Manager for SharePoint 2013
  • The configuration wizard is completed successfully.
WF Config Progress completed

Install SharePoint Workflow Manager Client

  • Log on to each server in the SharePoint Server 2013 farm and install the Workflow Manager Client for each server.
  • Download and install the Workflow Manager Client.
Install Workflow Manager Client for SharePoint 2016

Register Workflow Manager Service for SharePoint 2013

  • Run the SharePoint Management Shell as an administrator.
  • This is accomplished by right-clicking the SharePoint 2013 Management Shell and choosing Run as administrator.
Run SharePoint Management Shell as Administrator
  • Run the Register-SPWorkflowService cmdlet as shown below.
Register-SPWorkflowService -SPSite 'https://myhost/mysite' -WorkflowHostUri 'http://workflowhost:12291' -AllowOAuthHttp

SPSite: Specifies a site collection to configure.

It seems that each site collection needs to be registered with workflow service. But actually it’s not 100% correct, once you have registered a workflow service to any SharePoint site collection within the farm, it will be enabled for all SharePoint web applications/site collections. I am pretty sure about this behavior and that what I got on my farm.

WorkflowHostUri: Specifies a string of the full URI for the Workflow Service.

The provided ports must be the same provided ports in the Configure Ports step as above mentioned by default it’s 12291 for HTTP and 12290 for HTTPS.

  • The SharePoint Workflow Manager Service should be registered successfully.
Register SharePoint Workflow Service

If you have faced any issue during registering the SharePoint Workflow Manager Service, so it’s strongly recommended to check the below links:


Test SharePoint Workflow Manager 2013

To make sure that the workflow configuration is done successfully, you should check the following:

  • Open IIS > From left side expand Sites > Workflow Management Site.
IIS workflow managemnt site
  • From right side > Click Browse.
browse wofkflow management site url
  • The following page should be shown and that means the workflow manager has been connected and registered correctly
Test Workflow Manager

If the workflow manager API didn’t work , you will need to check 403 forbidden error.

  • Open SharePoint Designer > Workflows > Create Site Workflow > In Platform Type > the SharePoint 2013 Workflow should be now listed.
SharePoint workflow 2013 in SharePoint designer
  • Open Central Administration > Application Management > Manage Service Application .
Application Management - Manage Service Applications
  • Click on Workflow Service Application Proxy.
workflow service application proxy
  • Make sure that the Workflow is Connected.
workflow service status is connected

For more details, please check Test Workflow Manager Configuration In SharePoint Farm.


SharePoint Workflow Manager Tips and Considerations

  • The SharePoint 2013 Workflow platform is not supported in SharePoint Foundation 2013.
  • The SharePoint 2013 farm must be at least updated with March 2013 PU, and we recommend installing Service Pack 1.
  • Workflow Manager is not installed automatically when you install SharePoint Server 2013, you must download and install it.
  • The SharePoint 2010 Workflow platform is installed automatically when you install the SharePoint Server 2013.
  • The SharePoint 2013 Workflow platform is not installed by default, it requires to install the Workflow Manager.
  • When you installed the Workflow Manager on a server, it automatically installs the Workflow Manager Client on that server, and You will still need to install the Workflow Manager Client on any other additional SharePoint servers. For example, if you have a farm that contains five servers, and you installed the Workflow Manager on one of those servers, so you will need to install the Workflow Manager Client on the other 4 SharePoint servers.
  • You must install the Workflow Manager Client on each server in the SharePoint farm before you run the registration for workflow manager service cmdlet using PowerShell.

Conclusion

In this article, I have explained How to Install and Configure Workflow Manager SharePoint 2013 step by step.

Additionally, we have answered

  1. What’re the Workflow platform types available for SharePoint Server 2013?
  2. What’re the possible scenarios to install and configure Workflow Manager for SharePoint 2013 farm?
  3. How to install and configure Workflow Manager for SharePoint 2013 step by step?
  4. Important tips for configuring Workflow Manager for SharePoint 2013.

Applies To

  • SharePoint 2013.
  • Workflow Manager.
See Also
Have a Question?

If you have any related questions, please don’t hesitate to ask it at deBUG.to Community.

10 thoughts on “Configure Workflow Manager SharePoint 2013”

  1. Hi Mohamed,
    I wanted to thank you for all of your help. You were very patient with me and really pointed me in the right direction.

  2. This post was filled with so many good ideas that I saved the entire thing to bookmark. Thank you so much.

Leave a Reply