en-US/about_SPWebAppWorkflowSettings.help.txt

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
.NAME
    SPWebAppWorkflowSettings

# Description
    
    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).
    
.PARAMETER Url
    Key - string
    The URL of the web application

.PARAMETER ExternalWorkflowParticipantsEnabled
    Write - boolean
    Are external workflow participants enabled in the web app

.PARAMETER UserDefinedWorkflowsEnabled
    Write - boolean
    Are user defined workflows enabled in this web app

.PARAMETER EmailToNoPermissionWorkflowParticipantsEnable
    Write - boolean
    Are documents sent via email to external participants of workflow

.PARAMETER InstallAccount
    Write - string
    POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5


.EXAMPLE
    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
            {
                Url                                           = "Shttp://exmaple.contoso.local"
                ExternalWorkflowParticipantsEnabled           = $false
                EmailToNoPermissionWorkflowParticipantsEnable = $false
                PsDscRunAsCredential                          = $SetupAccount
            }
        }
    }