File Uncompression Task Properties
The File Uncompression Task Properties window contains the settings for a job step that executes a File Uncompression 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 extracted matches the value specified. |
| No files affected | No files were extracted. |
| One or more files affected | At least one file was extracted. |
Source
The Source page contains options for selecting the archives to extract files from.
Location
Select the location for the source archives. 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.
Files to uncompress
Enter the names of the archives to uncompress. You may uncompress multiple archives: enter one archive name per line. Each entry must be the full path and name of the archive. Wildcards and job variables can be used.
You are specifying here the name of the archive (e.g., the ZIP file). adTempus will extract all files from each specified archive.
Compression Type
Select the compression type used for the archives. Generally you can leave this set to Auto Detect, but you must select the Compression Type if you need to specify as password below for decryption.
Delete archives after files are extracted
Check this option to delete archives after the files have been extracted from them. Archives will only be deleted if all files are successfully extracted from them.
Encryption
If the archive is protected by encryption, select the encryption type and enter the password here.
This option is only available if you have selected a Compression Type.
Destination
The Destination page contains options specifying where the files will be uncompressed.
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.
Uncompress To
Specify the base directory where the files will be extracted.
Create a subdirectory for each archive
If you specified more than one archive on the Source page, check this option to have adTempus create a subdirectory for each archive. If this option is not checked, all files from all archives will go to the same directory.
Use path names from archive
Check this option to have adTempus recreate the directory structure stored in the archive. If you do not check this option, or if the archive does not include path information, all files will be written to the same directory.
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.
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 uncompressed. |
Related Concepts