MoveFile

MoveFile

SYNOPSIS

Moves specified file to a new directory.

SYNTAX

  - ActionType: MoveFile
    ActionDescription: 
    FileSource: 
    FileDestination: 
    Overwrite: 
    ExactVariableCheck: 

EXAMPLES

EXAMPLE 1

  - ActionType: MoveFile
    ActionDescription: Move log file
    FileSource: D:\log.txt
    FileDestination: D:\new\path\log.txt
    Overwrite: true
    ExactVariableCheck: false

EXAMPLE 2

  - ActionType: MoveFile
    FileSource: D:\log.txt
    FileDestination: D:\new\path\log.txt

EXAMPLE 3

  - ActionType: MoveFile
    FileSource: D:\log.txt
    FileDestination: D:\new\path\log.txt
    Overwrite: true

EXAMPLE 4

  - ActionType: MoveFile
    FileSource: $varFile1
    FileDestination: $varFile1Dest

PARAMETERS

ActionType

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

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

FileSource

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

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

FileDestination

This parameter specifies absolute path to where file should be moved to.

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

Overwrite

This parameter specifies if file should be overwritten in the destination path if it already exists there.

Required: false
Default Value: false
Accepted Value: true\false
Accepted Value Type: boolean
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