...
This Universal Extension provides the capability to compress and decompress a file or directory, with or without password encryption.
Version Information
| Template Name | Extension Name | Extension Version |
|---|---|---|
| File Compression | ue-util-compress | 1.2.0 |
Refer to Changelog for version history information.
...
The input fields for this Universal Extension are described in the following table.
| Field | Input type | Default value | Type | Description |
|---|---|---|---|---|
| Action | Required | Compress | Choice | The action performed upon the task execution. Available options are listed below.
|
| Algorithm | Required | ZIP | Choice | The compression algorithm to be used upon the action execution. Available options are listed below.
|
| Archiver | Required | 7za: 7-Zip (Windows) or p7zip (Linux) - standalone | Choice | The Archiver to be used upon the action execution. Available options are listed below.
|
| Archiver Path | Optional | - | Text | Custom path and file name for the Archiver. Required when Archiver is configured for "7-zip (custom path)". |
| Source file Optional since version 1.2.0 | Optional | - | Text | Path and file name of the file to compress or the archive to decompress. |
| Source File or Directory Introduced in version 1.2.0 | Optional | - | Text | Path of file name or directory to be used as source for compression or decompression with “Embedded (Linux)“ Archiver. |
| 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". |
| Output File or Directory Introduced in version 1.2.0 | Optional | - | Text | Path of filename that should be used as a compression target when using “Embedded (Linux)“ Archiver, or Path of directory in which the source zip file will be decompressed when using “Embedded (Linux)“ Archiver. If Output File or Directory/Output exists and Overwrite flag is "False" then folder with name output_ followed by the first available number is created. For example output_1. Used with “Embedded (Linux)“ Archiver. |
| 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". |
| Zip Compression Level | Required | 5 - Normal | Choice | The level of compression. Available options are listed below.
|
| Delete Original | Required | True | Boolean | Flag to configure for whether the Source File or Source File or Directory should be deleted at the end of compression. Used when Action is configured for "Compress". |
| Overwrite | Required | False | Boolean | Flag to specify the overwrite mode during extraction. Used when Action is configured for "Decompress". |
| Encryption | Required | None | Choice | The encryption algorithm for password protection of the archive. Available options are listed below.
|
| Password Credentials | Optional | - | Credentials | Credentials to be used for the compression or decompression with Encryption .The Credentials definition should be as follows.
|
| Additional switches | Optional | - | Text | Specifies additional parameters to be passed to the Archiver, separated by empty spaces. |
Task Examples
Compress File with AES-256 Password Encryption - 7zip Archiver
Example of Universal Task for compressing file with AES-256 password encryption.
Decompress File with 7-zip(custom path) Archiver Tool - 7zip Archiver
...
The output field for this Universal Extension is described below.
| Field | Type | Description |
|---|---|---|
| Archived Processed | Text | Archive name and path. Generated in "7zip" Archiver option. |
| Source Processed Introduced in version 1.2.0 | Text | Used to store the file or directory path used as the source of the compress/decompress action. Generated in "“Embedded (Linux)“" Archiver option. |
| Output Introduced in version 1.2.0 | Text | Used to store the directory path used as the output of the compress/decompress action. Generated in "Embedded" Archiver option. |
SUCCESS: Task executed successfully.
...
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: Task executed successfully. |
| 1 | FAIL | Failed Execution | FAIL: < Error Description > |
| 20 | DATA_VALIDATION_ERROR | Bad input fields validation | DATA_VALIDATION_ERROR: Some of the input fields cannot be validated. See STDERR for more details |
| 21 | 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 |
| 22 | FAIL | Fatal error | FAIL: Fatal error |
| 27 | FAIL | Command line error | FAIL: Command line error |
| 28 | FAIL | Not enough memory for operation | FAIL: Not enough memory for operation |
Extension Output
Attribute changed is always true on a successful execution of a task. In case of failure no extension output is produced.
...
Attribute result contains the following sub-attributes.
| Attribute | Output Type | Mandatory | Description |
|---|---|---|---|
| archive_processed | String | No | Archive name and path. Generated in "7zip" Archiver option |
| source_processed Introduced in version 1.2.0 | String | No | Used to store the file or directory path used as the source of the compress/uncompress action. Generated in "Embedded" Archiver option |
| output Introduced in version 1.2.0 | String | No | Job Name Used to store the directory path used as the output of the compress/decompress action. Generated in "Embedded" Archiver option |
STDOUT and STDERR
STDOUT and STDERR provide additional information to User. The populated content can be changed in future versions of this extension without notice.
...
This document references the following documents.
| Document Link | Description |
|---|---|
| Universal Templates | User documentation for creating, working with and understanding Universal Templates and Integrations. |
| Universal Tasks | User documentation for creating Universal Tasks in the Universal Controller user interface. |
| Credentials | User documentation for creating and working with credentials. |
| Resolvable Credentials Permitted Property | User documentation for Resolvable Credentials Permitted Property. |
| 7zip Official Page | User documentation for downloading 7zip command line tool. |
Changelog
ue-util-compress-1.2.0 (2022-09-23)
...