< Back

Set-AMWorkflowItem

Sat Jan 11, 2020 3:40 am

NAME Set-AMWorkflowItem



SYNOPSIS

Sets an item in a AutoMate Enterprise workflow





SYNTAX

Set-AMWorkflowItem -InputObject <Object> [[-ID] <String>] [-Construct <Object>] [-Agent <Object>] [-Enabled]

[-UseLabel] [-Label <String>] [-Height <Int32>] [-Width <Int32>] [-X <Int32>] [-Y <Int32>] [-Expression <String>]

[-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

Set-AMWorkflowItem can modify an item in a workflow object.





PARAMETERS

-InputObject <Object>

The object to modify - a workflow or a workflow item.



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-ID <String>

The ID of the item to modify (if passing in a workflow).



Required? false

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Construct <Object>

The new construct (Workflow/Task/Process/Condition) to set for this item.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Agent <Object>

The agent or agent group to assign to this item.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Enabled [<SwitchParameter>]

If the item is enabled or not.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-UseLabel [<SwitchParameter>]

If the item should use the configured label or not.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Label <String>

The label to place on the item (specify -UseLabel) to show the label in the workflow designer.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Height <Int32>

The height of the object in the workflow designer.



Required? false

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-Width <Int32>

The width of the object in the workflow designer.



Required? false

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-X <Int32>

The x location of the object in the workflow designer.



Required? false

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-Y <Int32>

The y location of the object in the workflow designer.



Required? false

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-Expression <String>

The expression to set on the evaluation object.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

The following AutoMate object types can be modified by this function:

Workflow

WorkflowItem





OUTPUTS



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



PS C:\\># Change the label on an item in a workflow



Get-AMWorkflow "Some Workflow" | Set-AMWorkflowItem -ID "{1103992f-cbbd-44fd-9177-9de31b1070ab}" -Label "Do

something" -UseLabel











RELATED LINKS

https://github.com/AutomatePS/AutomatePS