Set-AMWorkflowVariable

NAME Set-AMWorkflowVariable



SYNOPSIS

Sets a shared variable in a AutoMate Enterprise workflow





SYNTAX

Set-AMWorkflowVariable -InputObject <Object> [[-Name] <String>] [-InitialValue <String>] [-Description <String>]

[-Type {Auto | Text | Number}] [-PassValueFromParent] [-PassValueToParent] [-WhatIf] [-Confirm]

[<CommonParameters>]





DESCRIPTION

Set-AMWorkflowVariable can set the initial value and description of shared variables in a workflow object.





PARAMETERS

-InputObject <Object>

The object to modify.



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Name <String>

The name of the variable to modify.



Required? false

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-InitialValue <String>

The initial value of the variable.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Description <String>

The description of the variable.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Type

The data type of the variable.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-PassValueFromParent [<SwitchParameter>]

If specified, the variable will be configured to pass the value from the parent workflow to this workflow.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-PassValueToParent [<SwitchParameter>]

If specified, the variable will be configured to pass the value from this workflow to the parent workflow.



Required? false

Position? named

Default value False

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

WorkflowVariable





OUTPUTS



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



PS C:\\># Modify variable 'emailAddress' for workflow 'Some Workflow'



Get-AMWorkflow "Some Workflow" | Set-AMWorkflowVariable -Name "emailAddress" -InitialValue "person@example.com"

-PassValueFromParent -PassValueToParent:$false











RELATED LINKS

https://github.com/AutomatePS/AutomatePS