Disclaimer

Your use of this download is governed by Stonebranch’s Terms of Use, which are available at Stonebranch Integration Hub - Terms of Use.

Overview

File compression is a way to reduce overall file size without losing any of the primary data to make large files more manageable. This Universal Extension provides the capability to compress and decompress a file or directory, with or without password encryption.

Version Information

Refer to the changelog for version history information.

Key Features

Software Requirements

Input Fields

The input fields for this Universal Extension are described in the following table.

Configuration Examples

Scenario A Compress a file with AES-256 password encryption.	Scenario B Decompress a file with 7zip(custom path) Archiver.
Scenario C Compress a directory with “Embedded (Linux)“ Archiver.	Scenario D Decompress a multi-folder zip file with “Embedded (Linux)“ Archiver. Note that when Output File or Directory is not given, the zip is extracted at the same folder as the Source File or Directory with the same name in the example test_folder. If Output File or Directory/Output exists then a folder with the name test_folder_ followed by the first available number is created. For example test_folder_1.

Task Output

Output Only Fields

The output field for this Universal Extension is described below.

Exit Codes

The exit codes for this Universal Extension are described in the following table.

Extension Output

Attribute "changed" is always true in a successful execution of a task. In case of failure, no extension output is produced.

An example of the Extension Output for a Compress File with 7zz Archiver is presented below.

{
   "exit_code":0,
   "status_description":"SUCCESS: Task executed successfully.",
   "changed":true,
   "invocation":{
      "extension":"ue-util-compress",
      "version":"1.2.0",
      "fields":{
         "action":"compress",
         "algorithm":"zip",
         "zip_compression_level":1,
         "source_file":"test/test_file.txt",
         "archive":"test_archive.zip",
         "file":null,
         "overwrite":false,
         "encryption":"None",
         "credentials":null,
         "delete_original":false,
         "archiver_tool":"7zz",
         "archiver_path":null,
         "additional_switches":null
      }
   },
   "result":{
      "archive_processed":"test_archive.zip"
   }
}

An example of the Extension Output for a Compress Directory - “Embedded (Linux)“ Archiver example is presented below.

{
    "exit_code": 0,
    "status_description": "SUCCESS: Task executed successfully.",
    "changed": true,
    "invocation": {
        "extension": "ue-util-compress",
        "version": "1.2.0",
        "fields": {
            "action": null,
            "action_embedded": "compress",
            "algorithm": "zip",
            "zip_compression_level": 5,
            "source_file": null,
            "source_embedded": "test/test_folder",
            "archive": null,
            "output_embedded": null,
            "file": null,
            "overwrite": false,
            "overwrite_embedded": false,
            "encryption": null,
            "credentials": null,
            "delete_original": false,
            "delete_original_embedded": false,
            "archiver_tool": "embedded",
            "archiver_path": null,
            "additional_switches": "",
            "source_processed": null,
            "output_directory": null
        }
    },
    "result": {
        "source_processed": "test/test_folder",
        "output": "test/test_folder.zip"
    }
}


Attribute result contains the following sub-attributes.

STDOUT and STDERR

STDOUT and STDERR provide additional information to the User. The populated content can be changed in future versions of this extension without notice.

Integration Modifications

Modifications applied by users or customers, before or after import, might affect the supportability of this integration. The following modifications are discouraged to retain the support level as applied for this integration.

• Python code modifications should not be done.
• Template Modifications
  • General Section
    • "Name", "Extension", "Variable Prefix", "Icon" should not be changed.
  • Universal Template Details Section
    • "Template Type", "Agent Type", "Send Extension Variables", "Always Cancel on Force Finish" should not be changed.
  • Result Processing Defaults Section
    • Success and Failure Exit codes should not be changed.
    • Success and Failure Output processing should not be changed.
  • Fields Restriction Section
    The setup of the template does not impose any restrictions, however with respect to "Exit Code Processing Fields" section.
    1. Success/Failure exit codes need to be respected.
    2. In principle, as STDERR and STDOUT outputs can change in follow-up releases of this integration, they should not be considered as a reliable source for determining the success or failure of a task.

Users and customers are encouraged to report defects, or feature requests at Stonebranch Support Desk.

Document References

This document references the following documents.

Changelog

ue-util-compress-1.3.0 (2024-07-19)

Enhancements

• Added : Ability to specify an output directory when using 7zip (#41103).

Fixes

• Fixed: Windows paths containing spaces are now correctly evaluated (#30032).

ue-util-compress-1.2.0 (2022-09-23)

Enhancements

• Added: Introduction of "Embedded" Compression Method (#29539).
• Added: Directory compress/decompress capabilities (#29539).

ue-util-compress-1.1.0 (2022-04-12)

Enhancements

• Added: Archive Processed Output Only Field (#27582).
• Added: Automated Testing (#27582).

Fixes

• Fixed: Refactor field names and prefixes (#27315).