Skip to content

Latest commit

 

History

History
186 lines (139 loc) · 3.92 KB

Add-PnPWorkflowSubscription.md

File metadata and controls

186 lines (139 loc) · 3.92 KB
external help file applicable schema
SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
2.0.0

Add-PnPWorkflowSubscription

SYNOPSIS

Adds a workflow subscription to a list

SYNTAX

Add-PnPWorkflowSubscription -Name <String>
                            -DefinitionName <String>
                            -List <ListPipeBind>
                            -HistoryListName <String>
                            -TaskListName <String>
                            [-StartManually [<SwitchParameter>]]
                            [-StartOnCreated [<SwitchParameter>]]
                            [-StartOnChanged [<SwitchParameter>]]
                            [-AssociationValues <Dictionary`2>]
                            [-Web <WebPipeBind>]
                            [-Connection <SPOnlineConnection>]

EXAMPLES

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

PS:> Add-PnPWorkflowSubscription -Name MyWorkflow -DefinitionName SendMessageWf -list $list

Adds an Workflow with the name 'SendMessageWf' to the list $list.

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

PS:> $list | Add-PnPWorkflowSubscription -Name MyWorkflow -DefinitionName SendMessageWf

Adds an Workflow with the name "SendMessageWf" to the list $list.

------------------EXAMPLE 3------------------

PS:> Get-PnPList -Identity "MyCustomList" | Add-PnPWorkflowSubscription -Name MyWorkflow -DefinitionName SendMessageWf

Adds an Workflow with the name "SendMessageWf" to the list "MyCustomList".

PARAMETERS

-AssociationValues

Type: Dictionary`2
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-DefinitionName

The name of the workflow definition

Type: String
Parameter Sets: (All)

Required: True
Position: Named
Accept pipeline input: False

-HistoryListName

The name of the History list

Type: String
Parameter Sets: (All)

Required: True
Position: Named
Accept pipeline input: False

-List

The list to add the workflow to

Type: ListPipeBind
Parameter Sets: (All)

Required: True
Position: Named
Accept pipeline input: False

-Name

The name of the subscription

Type: String
Parameter Sets: (All)

Required: True
Position: Named
Accept pipeline input: False

-StartManually

Switch if the workflow should be started manually, default value is 'true'

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-StartOnChanged

Should the workflow run when an item is changed

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-StartOnCreated

Should the workflow run when an new item is created

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-TaskListName

The name of the task list

Type: String
Parameter Sets: (All)

Required: True
Position: Named
Accept pipeline input: False

-Connection

Optional connection to be used by cmdlet. Retrieve the value for this parameter by eiter specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

Type: SPOnlineConnection
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Web

This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.

Type: WebPipeBind
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

RELATED LINKS

SharePoint Developer Patterns and Practices