| external help file | Module Name | online version | schema |
|---|---|---|---|
AMSoftware.Crm.PowerShell.Commands.dll-Help.xml |
AMSoftware.Crm |
2.0.0 |
Execute a workflow.
Start-CrmProcess [-Process] <Guid> [-Record] <Guid[]> [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]
Execute a workflow.
The return value is the ID of the asynchronous operation (system job) that is created.
PS C:\> Get-CrmContent -Entity account | Execute-Process -Process 'AA5C6340-D76D-44E1-B3B8-1D3EFA0C4B8D'
Execute the workflow on all records in the 'account' entity.
Returns an object that represents the asyncoperation. By default, this cmdlet does not generate any output.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe id of the workflow (process) to execute.
Type: System.Guid
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: Falsethe ID of the record on which the workflow executes.
The entity is determined by the entity the workflow is associated with.
Type: System.Guid[]
Parameter Sets: (All)
Aliases: Id
Required: True
Position: 5
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalsePrompts you for confirmation before running the cmdlet.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseShows what would happen if the cmdlet runs. The cmdlet is not run.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.