Export (0) Print
Expand All
0 out of 7 rated this helpful - Rate this topic

Register-SPWorkflowService

SharePoint 2013

Configures the SharePoint host to use a workflow service.

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

Parameters

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.

noteNote:

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.

Detailed Description

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

Input Types

Return Types

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

Register-SPWorkflowService -SPSite 'https://myhost/mysite' -WorkflowHostUri 'https://workflowhost'

This example configures the SharePoint host by using the WorkflowHostUri parameter.

----------------EXAMPLE 2------------

Register-SPWorkflowService -SPSite 'https://myhost/mysite' -WorkflowHostUri 'https://workflowhost' -AllowOAuthHttp -Force

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

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.