ZIP in Memory Compression

This adapter creates a ZIP archive with one or multiple files from data deposited in an adapter-specific XML structure, and keeps the complete data in the memory, i.e. no file system access is required.

The ZIP in Memory Compression adapter is discontinued with version 6.2.0 of the X4 BPMS and will not be supported in future versions of the X4 BPMS. Please use the Zip Converter instead.

Properties

Operation

Defines the operation executed by the adapter

Possible values:

Zip: Create ZIP archive from data deposited in the input XML document in the memory
Unzip: Unzip the ZIP archive into the memory

Parameters

Adapter

Main adapter class (do not change!)

Possible values: de.softproject.integration.adapter.zipinmemory.ZipInMemory: Main class (default)

encoding

Character encoding for file/path names

Possible values:

Any valid encoding (e.g. UTF-8)
CP850: MS-DOS Germany (generated by MS Windows) (default)
(empty): UTF-8 (for downward compatibility with previous X4 Server release versions)

Input

If property Operation is set to Zip, the adapter expects an adapter-specific input XML structure. It contains the file names and the Base64-encoded contents of all files in the ZIP archive. Each <File> element corresponds to a file and each <Directory> element to an empty folder in the ZIP archive.

HTML/XML

<Archiv>
    <File name="File name" comment="Optional comment">
        <!--Base64-encoded data-->
    </File>
    <Directory name="Folder name/" />
</Archiv>

Output

If the property Operation is set to Unzip, the adapter creates an adapter-specific XML structure from a ZIP archive.

HTML/XML

<Archiv>
    <File name="Data.txt">Q29udGVudCBvZiB0aGlzIHRleHQgZmlsZQ==</File>
    <Directory name="Folder/" />
</Archiv>

Explanation:

Each element <Directory> corresponds to an (empty) folder in the ZIP archive.
Each element <File> corresponds to a file and saves the Base64-encoded file content as value.
The attribute name specifies the file or folder name.
The attribute size specifies the file size, if it is deposited within the ZIP archive.