File Compression Task Properties
The File Compression Task Properties window contains the settings for a job step that executes a File Compression 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 special Events:
| Event | Description |
| Affected file count matches a value | The number of files compressed matches the value specified. |
| No files affected | No files were compressed. |
| One or more files affected | At least one file was compressed. |
Source
The Source page contains options for selecting the files to compress.
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 store path information in the compressed archive, 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:\"
Delete files after they are added to the archive
Check this option to delete the source files after the archive has been created successfully.
Destination
The Destination page contains options specifying how and where the files will be compressed.
Compression Type
Select the compression standard to use.
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.
Compress To
Specify the name of the archive to create.
Store path information in archive
Check this option to save the relative path information for each file in the archive. This option is available only if you checked the Specify all files/paths relative to a single directory option on the Source page.
Existing Archive
Specify what adTempus should do if the target file already exists:
- Replace (overwrite) it Skip the file. The existing archive will be replaced with the new copy.
- Add to/update it. The existing archive will be updated with the source files. adTempus will add and update files in the archive as appropriate. It will not delete any files from the archive.
Make a backup of the existing file before replacing or updating it
Check this option to create a backup of the archive before replacing or updating it.
The backup name will be created by inserting a timestamp in the original name. For example, c:\target\myfiles.zip will be backed up to c:\target\myfiles.backup_20130501184244.zip.
Encryption
If you wish to encrypt the archive, specify the encryption type and password.
The available encryption types will depend on the compression standard being used.
For ZIP compression, the following encryption options are available:
- Standard pkzip encryption. This is the original encryption method used by pkzip and is considered to be weak encryption. This encryption method is supported by most ZIP utilities.
- WinZIP AES 128-bit encryption. Uses 128-bit AES encryption. This encryption method may not be supported by all ZIP utilities.
- WinZIP AES 256-bit encryption. Uses 128-bit AES encryption. This encryption method may not be supported by all ZIP utilities.
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 compressed. |
| FileOperationTask.ErrorMessages | Contains any error messages reported by the task. 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 processed files. This will be a list in the form sourcefile1,sourcefile2,sourcefile3. If no files were successfully processed, this variable will not be set. |
| FileOperationTask.FailedFiles | Contains a list of files that failed to process. This will be a list in the form sourcefile1,sourcefile2,sourcefile3. If no files failed to process, this variable will not be set. |
Related Concepts