ReadFile

ReadFile

SYNOPSIS

Read specified file to memory and set data to variable.

SYNTAX

  - ActionType: ReadFile
    ActionDescription: 
    FileName:
    Out: 
    ExactVariableCheck: 

EXAMPLES

EXAMPLE 1

  - ActionType: ReadFile
    ActionDescription: Read logs
    FileName: D:\log1.txt
    Out: $var1
    ExactVariableCheck: false

EXAMPLE 2

  - ActionType: ReadFile
    FileName: D:\log1.txt
    Out: $var1

EXAMPLE 3

  - ActionType: ReadFile
    FileName: D:\log1.txt
    Out: $var1, $var2

PARAMETERS

ActionType

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

Required: true
Default Value: ReadFile
Accepted Value: ReadFile
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

FileName

This parameter specifies absolute path to file which should be read.

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

Out

This parameter specifies variable or list of variables separated with comma to which value should be set.

Required: false
Default Value: none
Accepted Value: variable or list of variables separated with comma (,)
Accepted Value Type: string
Accepts Variables: true

ExactVariableCheck

This parameter specifies how to check YAML file variables specified in other parameters. 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