Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

FeatureDescription

Actions

  • Compress files or directories.
  • Decompress zip files with files or directories.
Other
  • Support for AES-256 password encryption for files.
  • Support for 7-Zip (Windows/Linux) and p7zip (Linux).
  • Support for Embedded (Linux).

Version Information

Template NameExtension NameVersionStatus
File Compressionue-util-compress1 (Current 1.3.0)Fixes and new Features are introduced.

Refer to the changelog for version history information.

Software Requirements

AreaDetails
Universal Controller

Universal Controller Version >= 7.3.0.0.

Universal Agent & Python version

Requires Python version 3.7. Only Agents of version >= 7.3 are supported.

  • 7z Archiver supports Windows and Linux agents.
  • Embedded Archiver supports Linux agents.
Software Requirements
  • 7zip command line tool. 7-zip or p7zip version 15.05 or newer is required to be installed in Universal Agent, tested with 7-zip 21.06 and p7zip 16.02.
  • Embedded Archiver. This Archiver is part of the standard Python Standard Library. Zlib library is also wanted but not needed for better compressions.

More information about the Agent Requirements of 7-Zip can be found here.

...

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

Code Block
languagetext
{
   "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.

Code Block
languagetext
{
    "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"
    }
}

...

Document LinkDescription
Universal TemplatesUser documentation for creating, working with, and understanding Universal Templates and Integrations.
Universal TasksUser documentation for creating Universal Tasks in the Universal Controller user interface.
CredentialsUser documentation for creating and working with credentials.
Resolvable Credentials Permitted PropertyUser documentation for Resolvable Credentials Permitted Property.
7zip Official PageUser documentation for downloading the 7zip command line tool.

Anchor
changelog
changelog

Changelog

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

...