User Guide

10.2.3
- 10.5.3
- 10.5.0
- 10.4.0
- 10.2.2 HotFix 1
- 10.2.2
- 10.2.1
- 10.2

Back Next

Copy Task

The Copy task can copy one or more files into a destination directory on the local file system or network share.

Field	Definition
Basic Tab
Label	Specify a label for this task.
Source File	Specify the path and name of a single file to be copied. This value must be a file, not a directory.
Source Files Variable	Specify the name of a variable of type File List which contains the files to copy. For example, ${variableName}.
Destination File	Specify the path and name of the destination file. It is invalid to specify this value if you are copying multiple files.
Destination Directory	Specify the directory to which the specified source files should be copied. You must specify this attribute if you are copying multiple files using one or more File Set elements, or a Source Files Variable.
When File Exists	Specify the action to take when a destination file already exists. The default value is ''rename'' which changes the destination file name to a new name so the existing file remains untouched. Default Value: rename
Advanced Tab
Flatten Destination Directory	Specify whether or not to copy all source files directly into the specified destination directory, without creating any sub directories. The default value is false, which creates sub directories to match the source directories. Default Value: false
Preserve Dates	Specify whether or not the last-modified date of the copies should remain consistent with the source files. The default behavior is to leave them as they are set by the file system. Default Value: false
File Name Prefix	Specify the string to prepend to the output file names.
File Name Suffix	Specify the string to append to the output file names.
Output Variables Tab
Processed Source Files Variable	If desired, specify the name of a variable which will contain the file(s) in the source location. The variable will be of type File List and may be used in subsequent tasks that accept a File List input variable. The variable will be created if it does not exist.
Number of Bytes Copied Variable	If desired, specify the name of a variable which will contain the number of bytes copied. The variable may be used in subsequent tasks. The variable will be created if it does not exist.
Number of Files Copied Variable	If desired, specify the name of a variable which will contain the number of files copied. The variable may be used in subsequent tasks. The variable will be created if it does not exist.
Destination Files Variable	If desired, specify the name of a variable which will contain the file(s) in the destination location. The variable will be of type File List and may be used in subsequent tasks that accept a File List input variable. The variable will be created if it does not exist.
Control Tab
Version	The version of this task.
Log Level	Specify the level of logging to use while executing this task. Valid options are - silent, normal, verbose and debug. Default Value: Inherited from parent Module
Execute Only If	Specify a condition that must be satisfied before this task can be executed. This task will be skipped if the specified condition is not met.
Disabled	Whether or not this task is disabled. Default Value: false
On Error Tab
On Error	Specify the action to take when this task errors out. Valid options are - abort, continue, call:[module] and setVariable:[name]=[value]. For call:[module] replace [module] with the name of the module in the project (e.g. call:ErrorModule). For setVariable:[name]=[value] replace [name] with a variable name and [value] with the variable value (e.g. setVariable:error=true). Default Value: Inherited from parent Module

This task uses the File Set Elements. The field definitions for the File Set Elements can be found on the File Lists and File Sets topic.

Rename Saved Search

Table of Contents

User Guide

User Guide

Copy Task

Copy Task