...
The input fields for this Universal Extension are described in the following table.
Field | Input type | Default value | Type | Description |
|---|---|---|---|---|
Action | Required | Compress file | Choice | The action performed upon the task execution. Available options are:
|
Algorithm | Required | zip | Choice | The compression algorithm to be used upon the action execution. Available option is:
|
Archiver Tool | Required | 7za: 7-Zip (Windows) or p7zip (Linux) - standalone | Choice | The archiver tool to be used upon the action execution. Available options are:
|
Archiver Path | Optional | - | Text | Custom path and file name for the archiver tool. Required when Archiver Tool is configured for "7-zip(custom path)". |
Source file | Required | - | Text | Path and file name of the file to compress or the archive to extract. |
Archive | Optional | - | Text | Path and file name of the target archive file. Default value will be Source File with the algorithm archive suffix. Used when Action is configured for "Compress file". |
File | Optional | - | Text | The file to be extracted. If value is empty, then default extraction of the archive content. Used when Action is configured for "Decompress file". |
Zip Compression Level | Required | 5 - Normal | Choice | The level of compression. Available options are:
|
Delete Original | Required | True | Boolean | Flag to configure for whether the Source File should be deleted at the end of compression. Used when Action is configured for "Compress file". |
Overwrite | Required | False | Boolean | Flag to specify the overwrite mode during extraction. Used when Action is configured for "Decompress file". |
Encryption | Required | None | Choice | The encryption algorithm for password protection of the archive. Available options are:
|
Password Credentials | Optional | - | Credentials | The password to be used for the compression or decompression. Required when Encryption is configured for "AES-256". |
Additional switches | Optional | - | Text | Specifies additional parameters to be passed to the archiver tool, separated by empty spaces. |
Task Examples
Compress File with AES-256 Password Encryption
...
The exit codes for this Universal Extension are described in the following table.
Exit Code | Status Classification Code | Status Classification Description | Status Description |
|---|---|---|---|
0 | SUCCESS | Successful Execution | SUCCESS: Successful Task execution |
1 | FAIL | Failed Execution | FAIL: < Error Description > |
11 | FAIL | Warning (Non fatal error(s)). For example, one or more files were locked by some other application, so they were not compressed. | FAIL: Warning |
12 | FAIL | Fatal error | FAIL: Fatal error |
17 | FAIL | Command line error | FAIL: Command line error |
18 | FAIL | Not enough memory for operation | FAIL: Not enough memory for operation |
20 | DATA_VALIDATION_ERROR | Bad input fields validation | DATA_VALIDATION_ERROR: Some of the input fields cannot be validated. See STDERR for more details |
255 | FAIL | User stopped the process | FAIL: User stopped the process |
Extension Output
The Extension Output for this Universal Extension is described below.
...