Review Workflow Configuration Settings
Scenario/Problem:
You need to review the overall workflow configuration settings for a
particular web application on the SharePoint farm or a site collection.
Solution: Use the Get-SPWorkflowConfig cmdlet.
The Get-SPWorkflowConfig cmdlet enables you to review the current workflow configuration settings for a specified web application or site collection. Listing 1 illustrates running this cmdlet with the WebApplication parameter. Listing 2 shows the site collection command line. Figure 1 shows sample results of both command lines.
Listing 1. Reviewing the Workflow Configuration for a Web Application
Get-SPWorkflowConfig -WebApplication "SharePoint - 80"
Listing 2. Reviewing the Workflow Configuration for a Site Collection
Get-SPWorkflowConfig -SiteCollection "http://sp2013"
Figure 1. Get-SPWorkflowConfig displays the workflow configuration settings.
Modify Workflow Configuration Settings
Scenario/Problem: You need to modify the overall SharePoint Designer settings for a particular web application on the SharePoint farm.
Solution: Use the Set-SPWorkflowConfig cmdlet.
The Set-SPWorkflowConfig cmdlet
enables you to modify the workflow configuration settings for a
specific web application or site collection. Each setting, listed here,
is a Boolean parameter:
• DeclarativeWorkflowsEnabled
• EmailNoPermissionParticipantsEnabled
• SendDocumentToExternalParticipants
Listing 3 shows a sample modification command line for a web application. Listing 4 illustrates modification of the site collection workflow configuration.
Listing 3. Modifying the Workflow Settings for a Web Application
Set-SPWorkflowConfig -WebApplication "SharePoint - 80"
-DeclarativeWorkflowsEnabled:$true
-EmailNoPermissionParticipantsEnabled:$false
-SendDocumentToExternalParticipants:$false
Listing 4. Modifying the Workflow Settings for a Site Collection
Set-SPWorkflowConfig -SiteCollection "http://sp2013"
-DeclarativeWorkflowsEnabled:$true
-EmailNoPermissionParticipantsEnabled:$false
-SendDocumentToExternalParticipants:$false
Tip
Use Get-SPWorkflowConfig to validate the modifications. The site collection output only displays the DeclarativeWorkflowEnabled setting.
The DeclarativeWorkflowEnabled parameter determines whether users can define workflows from deployed managed code. The default value is True.
The EmailNoPermissionParticipantsEnabled
parameter determines whether a user who does not have permissions to
the site should receive an e-mail if a task is assigned to him or her.
The default value is True.
The SendDocumentToExternalParticipants parameter specifies whether external users should receive a copy of the workflow document. The default value is False.
These parameters correspond, respectively, to the workflow settings available in Central Administration, as shown in Figure 2.
Figure 2. Workflow settings for a web application in Central Administration.
