SetVariableValue

SetVariableValue

SYNOPSIS

Sets value to variable.

SYNTAX

  - ActionType: SetVariableValue
    ActionDescription: 
    Variable: 
    Value: 
    ExactVariableCheckFromVariable: 
    ExactVariableCheckFromValue: 

EXAMPLES

EXAMPLE 1

  - ActionType: SetVariableValue
    ActionDescription: Sets value to variable
    Variable: $var1
    Value: some value
    ExactVariableCheckFromVariable: false
    ExactVariableCheckFromValue: false

EXAMPLE 2

  - ActionType: SetVariableValue
    ActionDescription: Sets value to variables
    Variable: $var1, $var2, $otherVar
    Value: Lorem ipsum
    ExactVariableCheckFromVariable: false
    ExactVariableCheckFromValue: false

EXAMPLE 3

  - ActionType: SetVariableValue
    Variable: $var1, $var2, $otherVar
    Value: hello world

EXAMPLE 4

  - ActionType: SetVariableValue
    Variable: $var1
    Value: $otherVar

PARAMETERS

ActionType

This parameter specifies action name. SetVariableValue value is required for this action to be executed.

Required: true
Default Value: SetVariableValue
Accepted Value: SetVariableValue
Accepted Value Type: string
Accepts Variables: false

ActionDescription

This parameter specifies description of the action.

Required: false
Default Value: none
Accepted Value: any
Accepted Value Type: string
Accepts Variables: false

Variable

This parameter specifies variable or list of variables separated with comma (,).

Required: true
Default Value: none
Accepted Value: variable\variables (Example: $var1, $var2)
Accepted Value Type: string
Accepts Variables: true

Value

This parameter specifies value which should be assigned to variable\variables.

Required: true
Default Value: none
Accepted Value: string text or other variable
Accepted Value Type: string
Accepts Variables: true

ExactVariableCheckFromVariable

This parameter specifies how to check YAML file variables specified in Variable parameter. If value is:

• true - variable value will be set when it is a separated word. Example: $var1$var2 will not be considered as $var1 and $var2.
• false - variable value will be set even if it is not separated word . Example: $var1$var2 will be considered as $var1 and $var2.

Required: false
Default Value: none
Accepted Value: true\false
Accepted Value Type: boolean
Accepts Variables: false

ExactVariableCheckFromValue

This parameter specifies how to check YAML file variables specified in Value parameter. If value is:

• true - variable value will be set when it is a separated word. Example: $var1$var2 will not be considered as $var1 and $var2.
• false - variable value will be set even if it is not separated word . Example: $var1$var2 will be considered as $var1 and $var2.

Required: false
Default Value: none
Accepted Value: true\false
Accepted Value Type: boolean
Accepts Variables: false

NOTES