SharePoint 2013

Last modified: April 27, 2016

Applies to: SharePoint Server 2013 Standard

sourcecodeRegister-SPWorkflowService -SPSite <SPSitePipeBind> -WorkflowHostUri <String> [-AllowOAuthHttp <SwitchParameter>] [-AssignmentCollection <SPAssignmentCollection>] [-Force <SwitchParameter>] [-PartitionMode <SwitchParameter>] [-ScopeName <String>]

Use the Register-SPWorkflowService cmdlet to configure the SharePoint host to use a workflow service by using the SPSite and WorkflowHostUri parameters.

SharePoint Management Shell

Tip Tip

  For more information about WorkflowHostUri see the following:

>- Video series: Install and configure Workflow in SharePoint Server 2013 >- Configure workflow in SharePoint Server 2013 >- Workflow in SharePoint 2013

Parameter Required Type Description
SPSite Required Microsoft.SharePoint.PowerShell.SPSitePipeBind Specifies a site collection to configure.
WorkflowHostUri Required System.String Specifies a string of the full URI for the Workflow Service.
AllowOAuthHttp Optional System.Management.Automation.SwitchParameter Support OAuth over HTTP.
AssignmentCollection Optional Microsoft.SharePoint.PowerShell.SPAssignmentCollection Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.
Force Optional System.Management.Automation.SwitchParameter Use this parameter to overwrite existing configuration settings and ignore errors.
PartitionMode Optional System.Management.Automation.SwitchParameter Determines whether a workflow connects the farm to a single instance of the Workflow Service or connects each site subscription to its own instance of the Workflow Service.
ScopeName Optional System.String A name that identifies SharePoint to the workflow service.
Parameter Required Type Description
SPSite Required Microsoft.SharePoint.PowerShell.SPSitePipeBind
WorkflowHostUri Required System.String
AllowOAuthHttp Optional System.Management.Automation.SwitchParameter
AssignmentCollection Optional Microsoft.SharePoint.PowerShell.SPAssignmentCollection
Force Optional System.Management.Automation.SwitchParameter
PartitionMode Optional System.Management.Automation.SwitchParameter
ScopeName Optional System.String

----------------EXAMPLE 1------------

sourcecodeRegister-SPWorkflowService -SPSite 'https://myhost/mysite' -WorkflowHostUri 'http://workflowhost:12991'

This example configures the SharePoint host by using the WorkflowHostUri parameter. ----------------EXAMPLE 2------------

sourcecodeRegister-SPWorkflowService -SPSite 'https://myhost/mysite' -WorkflowHostUri 'http://workflowhost:12991' -AllowOAuthHttp -Force

This example configures the SharePoint host to use OAuth by using the WorkflowHostUri and AllowOAuthHttp parameters.