Decompress File(s)
Decompress action tasks decompress zipped job files (files compressed as zip files).
Input
This task only accepts ZIP Files, however it is not necessary that the job file be the ZIP, since this file path and name can be specified in the task itself.
Processing
Every file in the ZIP is extracted to the specified location. If a folder structure exists in the ZIP, it is respected in the output folder.
Output
This task outputs the data file it received with no modification. Metadata and job files are not touched either.
Decompress action task properties are as follows:
General Tab
- Zip file name: Enter the name of the zipped file. In this variable property box, you may enter static characters, variables, job information elements, data selections, or any combination of these.
- Output folder: Enter the name of the folder in which you want the decompressed files to be stored.
- File mask: Enter a file name mask to specify which files must be decompressed. Leave the default value of *.* to decompress all the files found within the zip.
- Password: Enter a password if the zip file is password protected.
- Restore path structure: Select if you want the complete file structure to be rebuilt from the output folder to the decompressed files.
- Force directories: Select if you want to allow the system to create new folders when required. If this option is not select and the Decompress action task tries to save a file to a folder that does not exist, the task will fail.
- Overwrite existing files: Select if you want decompressed files that have the same name as existing files to overwrite the existing files.
On Error Tab
By default, any action task, branch, splitter or condition that generates an error will simply be ignored, and the task just under it (not within a branch) will be given control of the job file without any modification. Any initial input task that generates an error will stop the process from running as a whole, and output tasks will not generate output. The On Error tab can be used to overwrite the default behaviors.
- Send to Process: Check this option to send the job file to an error management process.
- Error Process drop-down: Enabled only when the Send to Process option is checked. Lists any process of which the initial input task is the Input Error Bin task.
- Action Group: This group is disabled in the initial input tasks and defaults to Stop Process. In all other tasks where the On Error tab is present, the following options are available:
- Ignore: The task is ignored as if it did not exist, and the job file is passed on to the next task in the process.
- Stop Branch: If the task is in a branch of the process, the branch is stopped and the job file is returned to the process after the branch. The branch will not produce any output.
- Stop Process: The process is stopped and no more processing is done. No further output is produced.
- Log Message: Check this option to enable logging a custom error message in the PlanetPress Suite Workflow Tools' log file.
- Message: Enabled only when the Log Message option is checked. Enter a message that will be logged in the PlanetPress Suite Workflow Tools' log file. You can use any variables available in PlanetPress Workflow to customize the message.
- Store the message in variable: Select in which jobinfo, local or global variable you want to store the message content.
- ID: Enter an error ID. This ID will be visible in the Windows Event Viewer. However, the ID is not visible in the PlanetPress Suite Workflow Tools' log file.
- Store the ID in variable: Select in which jobinfo, local or global variable you want to store the error ID.
- Reset to defaults: Resets all options in this tab to their default values.
If storing the message or ID, if they are store in a jobinfo they will be available in any error handling process where errors are being forwarded. In all cases, if your process continues after the error, the contents of the variables selected in this window will be available for the rest of your process, or whenever they are overwritten.
Common Errors
Though some error messages are specific to a task in particular, others may apply to any and all tasks because they are related more to the system than to PlanetPress itself. Some examples would be W3813, W3830, W3991, W4005. These correspond to issues such as not having any space to write files, permission errors on folders or files, etc.
Comments Tab
The Comments tab, added in PlanetPress Suite 7.5, is common to all tasks. It contains a single text area (Task comments) that lets you write comments about the task. These comments are saved when the dialog is closed with the OK button, and are displayed in The Task Comments Pane.