SPWebAppWorkflowSettings

SPWebAppWorkflowSettings

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
WebAppUrl	Key	String	The URL of the web application
ExternalWorkflowParticipantsEnabled	Write	Boolean	Are external workflow participants enabled in the web app
UserDefinedWorkflowsEnabled	Write	Boolean	Are user defined workflows enabled in this web app
EmailToNoPermissionWorkflowParticipantsEnable	Write	Boolean	Are documents sent via email to external participants of workflow
InstallAccount	Write	PSCredential	POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5

Description

Type: Distributed Requires CredSSP: No

This resource is responsible for setting web application settings that are found under the "workflow settings" screen in central admin. The web application is specified through the URL property, and then any combination of settings can be applied. Any settings not included will be left as the default (or whatever they have been manually changed to within SharePoint).

Examples

Example 1

This example shows how to apply workflow settings to the specific web application

    Configuration Example
    {
        param(
            [Parameter(Mandatory = $true)]
            [PSCredential]
            $SetupAccount
        )
        Import-DscResource -ModuleName SharePointDsc

        node localhost {
            SPWebAppWorkflowSettings PrimaryWebAppWorkflowSettings
            {
                WebAppUrl                                     = "Shttp://example.contoso.local"
                ExternalWorkflowParticipantsEnabled           = $false
                EmailToNoPermissionWorkflowParticipantsEnable = $false
                PsDscRunAsCredential                          = $SetupAccount
            }
        }
    }