File Transfer Task Properties
The File Transfer Task Properties window contains the settings for a job step that executes a File Transfer Task.
Property Pages
Property pages common to all Tasks
General
Name for this step (optional)
Optionally, specify a descriptive name for the step.
Enable this step
Uncheck this box to disable the step. If the step is not enabled, it will be skipped at execution.
Description/Notes
Enter any extended descriptive information or notes for this step.
Conditions
The Conditions page defines conditions that must be satisfied before the step is run.
Condition Criteria
The Condition Criteria determine how the conditions should be evaluated:
- Execute only if all conditions are met. The step is only executed if all of the listed conditions are met.
- Execute if any condition is met. The step is executed if any of the listed conditions is met.
If Conditions are not satisfied
The satisfaction options determine what adTempus should do if the conditions are not satisfied:
- Fail the step. The step is not executed; the status is set to Failed.
- Execute anyway. The step is executed anyway.
- Skip the step (do not report as a failure). The step is not run, but it is not treated as a failure. The status of the step is reported as "Skipped (conditions not met)."
Conditions List
The Conditions list lists the conditions that have been defined for the step. You can add, edit, or delete conditions. See the Conditions topic for information on the available condition types.
Variables
The Variables page allows you to define Job Variables for this step. You can add new Variables, or override the values of Variables inherited from the Job. Any Variables you define or override here affect only this step of the Job.
To set Variables that apply to the entire job, use the Variables page in the Job properties.
Responses
The Responses page defines the actions that adTempus should take in response to events that are fired during execution of the step. You can add, edit, delete, or reorder responses.
All job steps support the events listed below. Some tasks may define additional events .
| Event | Description |
| Step Started | Occurs at the beginning of the step. |
| Step Ended | Occurs at the end of the step, regardless of the step result. |
| Step Failed | Occurs if the step fails for any reason. |
| Step Restarted | Occurs if the step is restarted due to a Response. |
| Restart Limit Exceeded | Occurs if the restart limit is exceeded. |
| Step skipped | Occurs when the step is skipped, either because conditions were not met (if the Skip... option is selected on the Conditions page) or due to a skip option specific to the task. |
| One or more conditions failed | Occurs if one or more Conditions for the step is not satisfied. |
 Conditions not met within the specified time |
Occurs if the job or a step within the job has been waiting for conditions for longer than the specified time. |
In addition to the standard Response Events, this task defines the following events:
| Event | Description |
| Affected file count matches a value | The number of files transferred/deleted matches the value specified. |
| No files affected | No files were transferred/deleted. |
| One or more files affected | At least one file was transferred/deleted. |
Source
The source page contains options for selecting the files to copy, move, or delete.
Action
Select the action you want to perform: Copy, Move, or Delete files.
Location
Select the location for the source files. If the files are located on the adTempus server or another computer reachable using a standard UNC share, select Local or Network File.
If the files are located on a remote file server (such as FTP or SFTP), select the file server or create a new one. This defines the settings needed for adTempus to connect to the file server.
Source Root
The Source Root option determines how you will specify the files to include.
Specify all files/paths relative to a single directory
If you choose Specify all files/paths relative to a single directory, you will enter each file name relative to the root folder you define.
For example, suppose all the files you wish to transfer are located below the "c:\sourcefiles" directory. You would specify "c:\sourcefiles" as the source root here. In the Include Files list you would specify the files relative to that location, e.g.:
file_a.txt
file_b.txt
subdir\file_c.txt
The root directory name may include job variables.
Include all subdirectories
If you check Include all subdirectories, adTempus will search file files that match the patterns you specify in the Include Files list in the source root directory and all of its subdirectories. If you do not check this option, subdirectories will not be searched unless you include them explicitly in the Include Files list.
Specify absolute paths
If you choose Specify absolute paths, you will enter the full path for each file. From the example above, you would specify the Include Files as:
c:\sourcefiles\file_a.txt
c:\sourcefiles\file_b.txt
c:\sourcefiles\subdir\file_c.txt
If you want to keep the source directory structure during the transfer, you must use the Specify all files/paths relative to a single directory option.
Include Files
Specify the names or patterns of the files to include.
If you selected the Specify all files/paths relative to a single directory option, each entry must be a file name only or a path relative to the source root; it cannot start with "\", "/", or a drive letter.
If you selected the Specify absolute paths option, each entry must include a full path to the file.
You can use wildcards to match file and directory names, and the names may include job variables.
Exclude Files
Specify names or paths to exclude from the selection. You may specify full paths, partial paths, file names only, or wildcards. Job variables can be used.
Examples:
- sometext
- Excludes any file with "sometext" anywhere in its name or path
- \sometext\
- Excludes any file with "sometext" as one of the nodes in its path
- *.bak
- Excludes any file with file extension ".bak"
- sometext
- Excludes any file with "sometext" anywhere in its name or path
- c:\**\backup\*.*
- Recursively excludes all files in any directory named "backup" that appears anywhere below "c:\"
Destination
The Destination page contains options specifying the destination for copy and move operations.
Location
Select the location for the target files. If the target location is on the adTempus server or another computer reachable using a standard UNC share, select Local or Network File.
If the target location is on a remote file server (such as FTP or SFTP), select the file server or create a new one. This defines the settings needed for adTempus to connect to the file server.
Transfers from a remote location to a remote location are not supported. Such an operation must be performed in two steps: first download the files to a local temporary directory, then upload them to the target server.
Destination Directory
Specify the base directory for the files to be transferred to.
Preserve source directory structure
Check this option to preserve the relative directory structure of the source files. This option is available only if you checked the Specify all files/paths relative to a single directory option on the Source page.
If Preserve source directory structure is not checked, all files will be written to the root Destination Directory, regardless of what their original path was.
File Overwrite
Specify what adTempus should do if the target file already exists:
- Skip the file. The file will not be transferred.
- Overwrite the existing file. The file will be replaced.
-
Overwrite the existing file if it is older. The file will be replaced if it is older than the file being transferred.
Note: This option may not be reliable for files being transferred to or from an FTP server, since adTempus cannot always accurately determine the time zone for a file's timestamp when it is on an FTP server.
- Use a unique name for the new copy. The existing file will be preserved, and the source file will be copied under a new name. The new name will be created by inserting a timestamp in the original name. For example, afile.txt will be copied as afile.20130501184244.txt.
Make backups of existing files before replacing
Check this option to create a backup of any file that will be replaced during the operation.
The backup name will be created by inserting a timestamp in the original name. For example, c:\target\afile.txt will be backed up to "c:\target\afile.backup_20130501184244.txt.
Job Variables
This task sets the following Job Variables, which can be used by subsequent operations within the job:
| Variable | Description |
| FileOperationTask.ProcessedFileCount | The number of files transferred/deleted. |
| FileOperationTask.ErrorMessages | Contains any error messages reported by the transfer process. If there are multiple messages, messages will be separated by a newline ("\n") character. If there are no messages, the variable will not be set. |
| FileOperationTask.SucceededFiles | Contains a list of successfully transferred files. This will be a list in the form sourcefile1->targetfile1,sourcefile2->targetfile2,sourcefile3->targetfile3. If no files were successfully transferred, this variable will not be set. |
| FileOperationTask.FailedFiles | Contains a list of files that failed to transfer. This will be a list in the form sourcefile1->targetfile1,sourcefile2->targetfile2,sourcefile3->targetfile3. If no transfers failed, this variable will not be set. |
Related Concepts