# mulesoft Compression Module - Full Documentation

<!-- document id=25a136615b5f8f3e6a63f1721b9e47b0bae0c9a18a4b485b565e378e7388563e url=/mulesoft/current/en-us/compression-module/latest/compression-module-archive-extract-example.md -->

---
product: Compression Module
version: 2.2
is-latest-version: true
---

# Archive and Extract Example

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following Compression module example shows how to archive and extract files from a folder. The
File Connector **List** operation lists all the files from a folder named `input`. The **Compress**
operation then creates a compressed archive by generating an object with the key set to the file
name and the value set to the value of the listed files. Subsequently, the **Extract** operation
decompresses the archived file. Then, the **For Each** scope iterates over each extracted key/value
pair and writes the file to a new output folder with the key as the new file name and the value as
the corresponding extracted file content.

1.  In Studio, drag a **Scheduler** trigger to the flow.

2.  Set **Frequency** to `15` and **Time unit** to `SECONDS`.

3.  Drag the **List** operation alongside the **Scheduler** trigger.

4.  Add the connector configuration.

5.  Set **Directory path** to `input`.

6.  Drag a **Set payload** component alongside the **List** operation.

7.  Set **Value** to the following DataWeave expression:

```dataweave
output application/java
---
(0 to sizeOf(payload) - 1) as Array
reduce (index, acc={}) -&gt;
acc ++ { (payload[index].attributes.fileName): payload[index].payload}
```

8.  Drag the **Archive** operation alongside the **Set payload** component.

9.  Drag the **Extract** operation alongside the **Archive** operation.

10. Drag the **For Each** scope.

11. Set **Collection** to `payload`.

12. Drag the **Write** operation into the **For Each** scope.

13. Set **Path** to `#[output application/json--- "output/" ++ (payload pluck $$)[0]]`.

14. Set **Content** to `[CDATA[#[output application/java --- ( payload pluck $ )[0]]]`.

15. Drag a **Logger** component right to the **For Each** scope.

16. Set **Message** to `output application/json --- payload`.

17. Save and run your Mule app.

![Compression Module Archive Extract Flow in Studio Canvas](/mulesoft/current/en-us/compression-module/latest/_images/compression-module-example-1.png)

In the **Configuration XML** editor, the configuration looks like this:

```xml
  <flow name="archive-extract-test" >
	<scheduler doc:name="Scheduler">
		<scheduling-strategy >
			<fixed-frequency frequency="15" timeUnit="SECONDS"/>
		</scheduling-strategy>
	</scheduler>
	<file:list doc:name="List" config-ref="File_Config" directoryPath="input"/>
	<set-payload value='#[output application/java
---
(0 to sizeOf(payload) - 1) as Array
reduce (index, acc={}) -&gt;
acc ++ { (payload[index].attributes.fileName): payload[index].payload}]' doc:name="Set Payload" />

	<compression:archive doc:name="Archive" >
		<compression:archiver>
			<compression:zip-archiver />
		</compression:archiver>
	</compression:archive>

	<compression:extract doc:name="Extract"  >
		<compression:extractor >
			<compression:zip-extractor />
		</compression:extractor>
	</compression:extract>

	<foreach doc:name="For Each" collection="#[dw::Core::entriesOf(payload)]">
        <file:write doc:name="Write" config-ref="File_Config" path='#[output application/json&#10;---&#10;"output/" ++ payload.key]'>
            <file:content><![CDATA[#[output application/java --- payload.value]]]></file:content>
        </file:write>
    </foreach>

	<logger level="INFO" doc:name="Logger" message="#[output application/json --- payload]"/>
  </flow>
</mule>
```

## See Also

- [Compression Module Reference](https://docs.mulesoft.com/compression-module/latest/compression-documentation)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=6113751422777f374f5ad59669848bf8c684806d1f846f4aa0d3679d10b7fe6a url=/mulesoft/current/en-us/compression-module/latest/compression-module-archive-extract.md -->

---
product: Compression Module
version: 2.2
is-latest-version: true
---

# Archiving and Extracting Files

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The Compression module provides the **Archive** operation that enables you to compress a set of
entries into a new archive file and the **Extract** operation that enables you to decompress content
that represents an archive file.

## Configure Archive Operation

Given an input stream payload, the **Archive** operation enables you to compress all the payload
entries into a new archive file in the Zip format. The operation receives a map that identifies the
values to compress. Then, the operation receives each entry, which is placed inside the compressed
archive file with the entry name you provide in a DataWeave expression.

1.  In Studio, drag the **Archive** operation to your flow.

2.  Set **Entries** to a DataWeave script defining each name of the entry to compress as a key and
    the content of that entry as its value, for example:

    ```dataweave
    {
             summary.pdf: vars.summary,
             'details/result_001.pdf': vars.file1
             'details/result_002.pdf': vars.file2
           }
    ```

![Compression Archive operation configuration](/mulesoft/current/en-us/compression-module/latest/_images/compression-archive-operation.png)

In the **Configuration XML** editor, the configuration looks like this:

```xml
<compression:archive>
   <compression:entries>
    #[
       {
         summary.pdf: vars.summary,
         'details/result_001.pdf': vars.file1
         'details/result_002.pdf': vars.file2
       }
     ]
   </compression:entries>
   <compression:archiver>
       <compression:zip-archiver/>
   </compression:archiver>
</compression:archive>
```

The resulting archive contains three entries:\`summary.pdf\`, located at the root level and
`result_001.pdf` and `result_002.pdf`, located in the `details` directory.

```none
+- content.zip
|  \- summary.pdf
|  \+ details
   |  \- result_001.pdf
   |  \- result_002.pdf
```

Note that the slash `/` in the name of an entry, for example, `details/result_001.pdf`, indicates a
directory separation. All names are introspected to create directories inside the archive.

> [!NOTE] If you create the input to the **Archive** operation using a DataWeave expression, the
> DataWeave expression must output an object used to build the Java map object. Define unique keys
> to add the entire object to the archive.

## Configure ZIP64 Archiver Strategy

An archiver strategy compresses multiple entries into an archive. The Zip archiver strategy declares
that the content must be compressed using the Zip format. In Studio, the **Archiver** field is set
by default. To archive files and byte arrays greater than 4 GB, select the **Force ZIP64** field.

1.  In Studio, select the **Archive** operation from your flow.

2.  Set the **Entries** field to the following expression, for example:

    ```DataWeave
    output application/java
    ---
    (0 to sizeOf(payload) - 1) as Array
    reduce (index, acc={}) ->
    acc ++ { (payload[index].attributes.fileName): payload[index].payload}
    ```

3.  Select **Force ZIP64**.

![Force ZIP64 field selected](/mulesoft/current/en-us/compression-module/latest/_images/compression-zip64-archiver.png)

In the **Configuration XML** editor, the `zip-archiver` and `forceZip64` configuration look like
this:

```xml
<compression:archive doc:name="Archive">
<compression:entries>
<![CDATA[#[output application/java
---
(0 to sizeOf(payload) - 1) as Array
reduce (index, acc={}) ->
acc ++ { (payload[index].attributes.fileName): payload[index].payload}]]]>
</compression:entries>
<compression:archiver>
<compression:zip-archiver forceZip64="true"/>
</compression:archiver>
</compression:archive>
```

## Configure Extract Operation

The **Extract** operation enables you to decompress content that represents an archive in some
compression format. The entries of the archive file are returned as objects, each accessible by its
entry name.

1.  In Studio, select the **Extract** operation from your flow.

2.  Set the **Compressed** field to `vars.archive`.

![Compression Extract operation configuration](/mulesoft/current/en-us/compression-module/latest/_images/compression-extract-operation.png)

In the **Configuration XML** editor, the configuration looks like this:

```xml
<compression:extract>
    <compression:compressed>#[vars.archive]</compression:compressed>
    <compression:extractor>
        <compression:zip-extractor/>
    </compression:extractor>
</compression:extract>
```

Now, assume that you decompress an archive with three entries that contain the following structure:

```none
+- Archive
|  \- summary.pdf
|  \+ details
   |  \- result_001.pdf
   |  \- result_002.pdf
```

In this case, you can access the extracted contents of the entries using: `payload['summary.pdf']`
or `payload.details['result_001.pdf']`

## Configure Zip Extractor Strategy

An extractor strategy decompresses an archive with multiple entries that are compressed in a
particular format. The Zip archive strategy declares that the content must be extracted with the Zip
format. In Studio, the **Extractor** field is set by default.

![Force ZIP64 field selected](/mulesoft/current/en-us/compression-module/latest/_images/compression-zip64-archiver.png)

In the **Configuration XML** editor, the configuration looks like this:

```xml
<compression:zip-archiver/>
```

## See Also

- [Compression Module Reference](https://docs.mulesoft.com/compression-module/latest/compression-documentation)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=142b3a328d92c5cded96f99e174f780aeefa8a3bd4e3839feec23ee79ccd3edd url=/mulesoft/current/en-us/compression-module/latest/compression-module-compress-decompress-example.md -->

---
product: Compression Module
version: 2.2
is-latest-version: true
---

# Compress and Decompress Example

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The following Compression module examples show how to compress a file using the **Compress**
operation and decompress a payload from a remote service using the **Decompress** operation.

## Compress a File

In the following example, you configure the File Connector **Read** operation to read a file. Then,
the **Compress** operation compresses the file and saves it in GZip format. Subsequently, the File
Connector **Write** operation writes the content into the given path on demand.

1.  In Studio, drag the File Connector **Read** operation to your flow.

2.  Set **Path** to `file.txt`.

3.  Drag the **Compress** operation alongside the **Read** operation.

4.  Set **Compressor** to **Gzip compressor**

5.  Drag the **Write** operation alongside the **Compress** operation.

6.  Set **Path** to `file-txt.gz`.

In the **Configuration XML** editor, the configuration looks like this:

```xml
<file:read path="file.txt"/>
<compression:compress>
   <compression:compressor>
       <compression:gzip-compressor/>
   </compression:compressor>
</compression:compress>
<file:write path="file-txt.gz"/>
```

## Decompress a Payload from a Remote Service

In the following example, you configure the Web Service Consumer Connector **Consume** operation to
consume an operation that returns a Zip file from a server. Then, the **Decompress** operation
decompresses the Zip file.

1.  In Studio, drag the Web Service Consumer Connector **Consume** operation to your flow.

2.  Set **Connector configuration** to your operation configuration, for example `ZipServiceConfig`.

3.  Set **Operation** to the name of the web service operation to invoke, for example `returnsZip`.

4.  Drag the **Decompress** operation alongside the **Consume** operation.

5.  Set **Content** to `payload.body.zipContent`.

6.  Set **Compressor** to **Zip compressor**.

In the **Configuration XML** editor, the configuration looks like this:

```xml
<compression:decompress doc:name="Decompress" >
 <compression:compressed ><![CDATA[#[payload.body.zipContent]]]></compression:compressed>
    <compression:decompressor >
   <compression:gzip-decompressor />
</compression:decompressor>
</compression:decompress>
```

## See Also

- [Compression Module Reference](https://docs.mulesoft.com/compression-module/latest/compression-documentation)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=48dbc27cd0b6d2f0719343487f917f578a9b3715fc5f51234ca11d03db315739 url=/mulesoft/current/en-us/compression-module/latest/compression-module-compress-decompress.md -->

---
product: Compression Module
version: 2.2
is-latest-version: true
---

# Compressing and Decompressing a Single File

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The Compression module provides the **Compress** and **Decompress** operations that enable you to
compress or decompress a single file in the configured Gzip or Zip format.

## Configure Compress Operation

Given an input stream payload, the **Compress** operation enables you to compress the stream and
return a new compressed stream of bits. You can then store the compressed stream of bits in a file
system or transfer it to another system.

1.  In Studio, drag the **Compress** operation to your flow.

2.  Set **Content** to your input stream payload to compress.

3.  Set **Compressor** to **Gzip compressor** or **Zip compressor** strategy.

![Compressor operation configuration](/mulesoft/current/en-us/compression-module/latest/_images/compression-compressor-operation.png)

In the **Configuration XML** editor, the configuration looks like this:

```xml
<compression:compress>
   <compression:content>#[payload.data]</compression:content>
   <compression:compressor>
       <compression:zip-compressor/>
   </compression:compressor>
</compression:compress>
```

## Configure GZip Compressor Strategy

A compressor strategy compresses a file or a single-entry archive. The **Gzip compressor** strategy
declares that the content must be compressed in the Gzip format.

1.  In Studio, select the **Compress** operation from your flow.

2.  Set **Compressor** to **Gzip compressor**.

In the **Configuration XML** editor, the configuration looks like this:

```xml
<compression:compress doc:name="Compress">
       <compression:compressor >
	<compression:gzip-compressor/>
     </compression:compressor>
</compression:compress>
```

## Configure Zip Compressor Strategy

The **Zip compressor** \*strategy declares that the content must be compressed in the Zip format.

1.  In Studio, select the **Compress** operation from your flow.

2.  Set **Compressor** to **Zip compressor**.

3.  Select **Force ZIP64** to compress files and byte arrays greater than 4 GBs.

In the **Configuration XML** editor, the configuration looks like this:

```xml
<compression:compress doc:name="Compress">
       <compression:compressor >
	<compression:zip-compressor forceZip64="true"/>
     </compression:compressor>
</compression:compress>
```

## Configure Decompress Operation

The **Decompress** operation enables you to decompress a single-entry compressed content, which is
an archive in a specified compression format. Compressed archives can have multiple entries, but
this operation manages only single entry archives because if the archive contains more than one
entry, the operation does not know which to return. For multiple entry archives, use the **Extract**
operation, which enables you to choose only formats that accept multiple entries.

1.  In Studio, drag the **Decompress** operation to your flow.

2.  Set **Compressed** to your input stream payload to decompress.

3.  Set **Decompressor** to **Gzip decompressor** or **Zip decompressor** strategy.

![Compressor operation configuration](/mulesoft/current/en-us/compression-module/latest/_images/compression-decompressor-operation.png)

In the **Configuration XML** editor, the configuration looks like this:

```xml
<compression:decompress>
   <compression:content>#[payload]</compression:content>
   <compression:decompressor>
       <compression:gzip-decompressor/>
   </compression:decompressor>
</compression:decompress>
```

## Configure GZip Decompressor Strategy

A decompressor strategy decompress a file or a single-entry archive. The **Gzip decompressor**
strategy declares that the content must be decompressed with the Gzip format.

1.  In Studio, select the **Decompress** operation from your flow.

2.  Set **Decompressor** to **Gzip decompressor**.

In the **Configuration XML** editor, the configuration looks like this:

```xml
<compression:decompress doc:name="Decompress" >
			<compression:decompressor >
				<compression:gzip-decompressor />
			</compression:decompressor>
		</compression:decompress>
```

## Configure Zip Decompressor Strategy

The **Zip decompressor** strategy declares that the content must be decompressed with the Zip
format.

1.  In Studio, select the **Decompress** operation from your flow.

2.  Set **Decompressor** to **Zip decompressor**.

In the **Configuration XML** editor, the configuration looks like this:

```xml
<compression:decompress doc:name="Decompress" >
			<compression:decompressor >
				<compression:zip-decompressor />
			</compression:decompressor>
		</compression:decompress>
```

## See Also

- [Compression Module Reference](https://docs.mulesoft.com/compression-module/latest/compression-documentation)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=a2d9567ecfd1deaf3e6e5e08b838f0078413e63578df88d8bad03c04df095d13 url=/mulesoft/current/en-us/compression-module/2.0/index.md -->

---
product: Compression Module
version: 2.0
---

# Compression Module

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Compression Module v2.0

Compression Module supports and provides access to the most-used file archiver and compression
formats through a Mule app.

A file archiver is a computer program that combines a number of files together into one archive file
for easier transportation or storage, and most archivers employ data compression in their archive
formats to reduce the size of the final archive. However, not all compression algorithms can archive
multiple files. Some are limited to single-file data compression.

This module compresses and decompresses files for each of the available formats without losing any
of the features that the format associated algorithm provides.

To achieve this capability, the module provides two pairs of operations, one for compressing and
decompressing a single file, another for archiving and extracting a bundle of files. Each of these
operations can be configured with the compression or archiving strategies of your choice.

Release Notes:
[Compression Module Release Notes](https://docs.mulesoft.com/release-notes/mule-runtime/module-compression)  
Exchange: [Compression Module](https://www.mulesoft.com/exchange/org.mule.modules/mule-compression-module/)

## POM File Information

If you create an app outside of Studio, set your POM file information as follows:

```xml
<dependency>
  <groupId>org.mule.modules</groupId>
  <artifactId>mule-compression-module</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

Replace `x.x.x` with the version that corresponds to the connector you are using.

## Compress and Decompress a Single File

### Content Compression

Given an input stream, the module compresses the stream and returns a new compressed stream of bits
so it can be stored in a file system or transferred to another system.

#### Compressor Strategies

A Compressor strategy can compress a file or a single-entry archive.

##### GZip Compressor Strategy

When used in an operation, this strategy declares that the content should be compressed with the
`gzip` format.

```xml
<compression:gzip-compressor/>
```

##### Zip Compressor Strategy

When used in an operation, this strategy declares that the content should be compressed with the
`zip` format.

```xml
<compression:zip-compressor/>
```

#### Compress Operation

```xml
<compression:compress>
   <compression:content>#[payload.data]</compression:content> (1)
   <compression:compressor>
       <compression:zip-compressor/> (2)
   </compression:compressor>
</compression:compress>
```

<table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>The <code>InputStream</code> to be compressed. Defaults to <code>#[payload]</code>.</td></tr><tr><td><i data-value="2"></i><b>2</b></td><td>Compressor strategy to be used.</td></tr></tbody></table>

#### Compression Errors

If an error occurs while compressing the content, a `COMPRESSION:COULD_NOT_COMPRESS` error is
thrown.

## Content Decompression

Decompresses single-entry compressed content, which is assumed to be an archive in the specified
compression format.

### Decompressor Strategies

A Decompressor strategy knows how to decompress a file or a single-entry archive.

#### GZip Decompressor Strategy

When used in an operation, this strategy declares that the content should be decompressed with the
`gzip` format.

```xml
<compression:gzip-decompressor/>
```

#### Zip Decompressor Strategy

When used in an operation, this strategy declares that the content should be decompressed with the
`zip` format.

```xml
<compression:zip-decompressor/>
```

### Decompress Operation

```xml
<compression:decompress>
   <compression:content>#[payload]</compression:content> (1)
   <compression:decompressor>
       <compression:gzip-decompressor/> (2)
   </compression:decompressor>
</compression:decompress>
```

<table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>The <code>InputStream</code> to be decompressed. Defaults to <code>#[payload]</code>.</td></tr><tr><td><i data-value="2"></i><b>2</b></td><td>Decompressor strategy to be used.</td></tr></tbody></table>

#### Decompression Errors

If the given content does not match the format of the configured strategy, a
`COMPRESSION:INVALID_ARCHIVE` error will be thrown.

If the archive to be decompressed has more than one entry, this operation will fail with a
`COMPRESSION:TOO_MANY_ENTRIES` error, because it will not be able to choose only one entry to
return. For these cases, you should use the Extract operation.

## Archive and Extract Multiple Entries

### Archive

Given a Map of `<entryName,InputStream>`, the archiving process compresses all the given entries
into a new archive in the configured format.

#### Archiver Strategies

An Archiver strategy is for compressing multiple entries into an archive.

##### Zip Archiver Strategy

When used in an operation, the Zip Archiver strategy declares that the content should be compressed
with the `zip` format.

```xml
<compression:zip-archiver/>
```

### Archive Operation

This operation receives a Map that identifies the entries to be compressed and their values. Each
entry passed to this operation is placed inside the compressed archive bearing the name you provide.

```xml
<compression:archive>
   <compression:entries> (1)
    #[
       {
         summary.pdf: vars.summary,
         'details/result_001.pdf': vars.file1
         'details/result_002.pdf': vars.file2
       }
     ]
   </compression:entries>
   <compression:archiver>
       <compression:zip-archiver/> (2)
   </compression:archiver>
</compression:archive>
```

<table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>A DataWeave script defining each name of the entry to be compressed as a key and the content of that entry as its value.</td></tr><tr><td><i data-value="2"></i><b>2</b></td><td>The archiver strategy to be used.</td></tr></tbody></table>

The resulting archive contains _three entries_, one named `summary.pdf` at root level, the others
called `result_001.pdf` and `result_002.pdf`, inside a directory called `details`:

```none
+- content.zip
|  \- summary.pdf
|  \+ details
   |  \- result_001.pdf
   |  \- result_002.pdf
```

Note that the slash (`/`) in the name of an entry (for example, `details/result_001.pdf`) indicates
directory separation, so all names will be introspected to create directories inside the archive.

> [!NOTE] If you create the input to the Archive operation using a DataWeave expression, the
> DataWeave expression must output an Object, which is used to build the Java Map object. For the
> entire object to be added to the archive, every key must be unique.

#### Archive Errors

If a problem occur while compressing the content, a `COMPRESSION:COULD_NOT_COMPRESS` error will be
thrown.

## Extract

Decompresses content that represents an archive in some compression format.

### Extractor Strategies

An Extractor strategy can decompress an archive with multiple entries that are compressed in a
particular format.

#### Zip Strategy

When used in an operations, this strategy declares that the content should be extracted with the
`zip` format.

```xml
<compression:zip-archiver/>
```

### Extract Operation

```xml
<compression:extract>
    <compression:compressed>#[vars.archive]</compression:compressed> (1)
    <compression:extractor>
        <compression:zip-extractor/> (2)
    </compression:extractor>
</compression:extract>
```

<table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>The compressed content to be extracted. Defaults to <code>#[payload]</code>.</td></tr><tr><td><i data-value="2"></i><b>2</b></td><td>The entries of this archive are returned as objects, each accessible by its name. For example, assume that an archive with three entries with the following structure is decompressed:</td></tr></tbody></table>

```none
+- Archive
|  \- summary.pdf
|  \+ details
   |  \- result_001.pdf
   |  \- result_002.pdf
```

In this case, you can access the extracted contents of the entries like this:
`payload['summary.pdf']` or `payload.details['result_001.pdf']`

#### Archive and Extractor Example

This example reads in all the files from a folder named input, then creates a compressed archive by
creating an object with the key set to the file name, and the value to the value of the read file.
Next the archive is extracted, then the For-Each scope iterates over each extracted key/value and
writes the file to a new output folder with the key as the new file name, and the value the
corresponding extracted file content.

```xml
  <flow name="archive-extract-test" >
	<scheduler doc:name="Scheduler">
		<scheduling-strategy >
			<fixed-frequency frequency="15" timeUnit="SECONDS"/>
		</scheduling-strategy>
	</scheduler>
	<file:list doc:name="List" config-ref="File_Config" directoryPath="input"/>
	<set-payload value='#[output application/java
---
(0 to sizeOf(payload) - 1) as Array
reduce (index, acc={}) -&gt;
acc ++ { (payload[index].attributes.fileName): payload[index].payload}]' doc:name="Set Payload" />

	<compression:archive doc:name="Archive" >
		<compression:archiver>
			<compression:zip-archiver />
		</compression:archiver>
	</compression:archive>

	<compression:extract doc:name="Extract"  >
		<compression:extractor >
			<compression:zip-extractor />
		</compression:extractor>
	</compression:extract>

	<foreach doc:name="For Each"  collection="payload">
	  <file:write doc:name="Write"  config-ref="File_Config" path='#[output application/json
---
"output/" ++ (payload pluck $$)[0]]' >
	    <file:content ><![CDATA[#[output application/java --- ( payload pluck $ )[0]]]]></file:content>
	  </file:write>
	</foreach>

	<logger level="INFO" doc:name="Logger" message="#[output application/json --- payload]"/>
  </flow>
</mule>
```

#### Extractor Errors

If the content is not in the configured format, a `COMPRESSION:INVALID_ARCHIVE` error will be
thrown. For other errors that occur during the compression process, the operation throws a
`COMPRESSION:COULD_NOT_DECOMPRESS` error.

## Common Use cases

### Compress a File

This example reads a file, compresses it, and saves it.

```xml
<file:read path="file.txt"/>
<compression:compress>
   <compression:compressor>
       <compression:gzip-compressor/>
   </compression:compressor>
</compression:compress>
<file:write path="file-txt.gz"/>
```

### Decompress a Payload from a Remote Service

This example calls a server that returns and decompresses a Zip file.

```xml
<wsc:consume config="ZipServiceConfig" operation="returnsZip"/>
<compression:decompress>
   <compression:content>
      #[payload.body.zipContent]
   </compression:content>
   <compression:decompressor>
       <compression:zip-decompressor/>
   </compression:decompressor>
</compression:decompress>
```

## See Also

- [Compression Module Reference](https://docs.mulesoft.com/compression-module/2.0/compression-documentation)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=3205bec49c02cb901e0a4630b9cc15d54ec9f87e14cd5e525d7de54b16a83b27 url=/mulesoft/current/en-us/compression-module/2.1/index.md -->

---
product: Compression Module
version: 2.1
---

# Compression Module

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Compression Module v2.1

Compression Module supports and provides access to the most-used file archiver and compression
formats through a Mule app.

A file archiver is a computer program that combines a number of files together into one archive file
for easier transportation or storage, and most archivers employ data compression in their archive
formats to reduce the size of the final archive. However, not all compression algorithms can archive
multiple files. Some are limited to single-file data compression.

This module compresses and decompresses files for each of the available formats without losing any
of the features that the format associated algorithm provides.

To achieve this capability, the module provides two pairs of operations, one for compressing and
decompressing a single file, another for archiving and extracting a bundle of files. Each of these
operations can be configured with the compression or archiving strategies of your choice.

Release Notes:
[Compression Module Release Notes](https://docs.mulesoft.com/release-notes/mule-runtime/module-compression)  
Exchange: [Compression Module](https://www.mulesoft.com/exchange/org.mule.modules/mule-compression-module/)

## Compress and Decompress a Single File

### Content Compression

Given an input stream, the module compresses the stream and returns a new compressed stream of bits
so it can be stored in a file system or transferred to another system.

#### Compressor Strategies

A Compressor strategy can compress a file or a single-entry archive.

##### GZip Compressor Strategy

When used in an operation, this strategy declares that the content should be compressed with the
`gzip` format.

```xml
<compression:gzip-compressor/>
```

##### Zip Compressor Strategy

When used in an operation, this strategy declares that the content should be compressed with the
`zip` format.

```xml
<compression:zip-compressor/>
```

#### Compress Operation

```xml
<compression:compress>
   <compression:content>#[payload.data]</compression:content> (1)
   <compression:compressor>
       <compression:zip-compressor/> (2)
   </compression:compressor>
</compression:compress>
```

<table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>The <code>InputStream</code> to be compressed. Defaults to <code>#[payload]</code>.</td></tr><tr><td><i data-value="2"></i><b>2</b></td><td>Compressor strategy to be used.</td></tr></tbody></table>

#### Compression Errors

If an error occurs while compressing the content, a `COMPRESSION:COULD_NOT_COMPRESS` error is
thrown.

## Content Decompression

Decompresses single-entry compressed content, which is assumed to be an archive in the specified
compression format.

### Decompressor Strategies

A Decompressor strategy knows how to decompress a file or a single-entry archive.

#### GZip Decompressor Strategy

When used in an operation, this strategy declares that the content should be decompressed with the
`gzip` format.

```xml
<compression:gzip-decompressor/>
```

#### Zip Decompressor Strategy

When used in an operation, this strategy declares that the content should be decompressed with the
`zip` format.

```xml
<compression:zip-decompressor/>
```

### Decompress Operation

```xml
<compression:decompress>
   <compression:content>#[payload]</compression:content> (1)
   <compression:decompressor>
       <compression:gzip-decompressor/> (2)
   </compression:decompressor>
</compression:decompress>
```

<table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>The <code>InputStream</code> to be decompressed. Defaults to <code>#[payload]</code>.</td></tr><tr><td><i data-value="2"></i><b>2</b></td><td>Decompressor strategy to be used.</td></tr></tbody></table>

#### Decompression Errors

If the given content does not match the format of the configured strategy, a
`COMPRESSION:INVALID_ARCHIVE` error will be thrown.

If the archive to be decompressed has more than one entry, this operation will fail with a
`COMPRESSION:TOO_MANY_ENTRIES` error, because it will not be able to choose only one entry to
return. For these cases, you should use the Extract operation.

## Archive and Extract Multiple Entries

### Archive

Given a Map of `<entryName,InputStream>`, the archiving process compresses all the given entries
into a new archive in the configured format.

#### Archiver Strategies

An Archiver strategy is for compressing multiple entries into an archive.

##### Zip Archiver Strategy

When used in an operation, the Zip Archiver strategy declares that the content should be compressed
with the `zip` format.

```xml
<compression:zip-archiver/>
```

### Archive Operation

This operation receives a Map that identifies the entries to be compressed and their values. Each
entry passed to this operation is placed inside the compressed archive bearing the name you provide.

```xml
<compression:archive>
   <compression:entries> (1)
    #[
       {
         summary.pdf: vars.summary,
         'details/result_001.pdf': vars.file1
         'details/result_002.pdf': vars.file2
       }
     ]
   </compression:entries>
   <compression:archiver>
       <compression:zip-archiver/> (2)
   </compression:archiver>
</compression:archive>
```

<table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>A DataWeave script defining each name of the entry to be compressed as a key and the content of that entry as its value.</td></tr><tr><td><i data-value="2"></i><b>2</b></td><td>The archiver strategy to be used.</td></tr></tbody></table>

The resulting archive contains _three entries_, one named `summary.pdf` at root level, the others
called `result_001.pdf` and `result_002.pdf`, inside a directory called `details`:

```none
+- content.zip
|  \- summary.pdf
|  \+ details
   |  \- result_001.pdf
   |  \- result_002.pdf
```

Note that the slash (`/`) in the name of an entry (for example, `details/result_001.pdf`) indicates
directory separation, so all names will be introspected to create directories inside the archive.

> [!NOTE] If you create the input to the Archive operation using a DataWeave expression, the
> DataWeave expression must output an Object, which is used to build the Java Map object. For the
> entire object to be added to the archive, every key must be unique.

#### Archive Errors

If a problem occur while compressing the content, a `COMPRESSION:COULD_NOT_COMPRESS` error will be
thrown.

## Extract

Decompresses content that represents an archive in some compression format.

### Extractor Strategies

An Extractor strategy can decompress an archive with multiple entries that are compressed in a
particular format.

#### Zip Strategy

When used in an operations, this strategy declares that the content should be extracted with the
`zip` format.

```xml
<compression:zip-archiver/>
```

### Extract Operation

```xml
<compression:extract>
    <compression:compressed>#[vars.archive]</compression:compressed> (1)
    <compression:extractor>
        <compression:zip-extractor/> (2)
    </compression:extractor>
</compression:extract>
```

<table><tbody><tr><td><i data-value="1"></i><b>1</b></td><td>The compressed content to be extracted. Defaults to <code>#[payload]</code>.</td></tr><tr><td><i data-value="2"></i><b>2</b></td><td>The entries of this archive are returned as objects, each accessible by its name. For example, assume that an archive with three entries with the following structure is decompressed:</td></tr></tbody></table>

```none
+- Archive
|  \- summary.pdf
|  \+ details
   |  \- result_001.pdf
   |  \- result_002.pdf
```

In this case, you can access the extracted contents of the entries like this:
`payload['summary.pdf']` or `payload.details['result_001.pdf']`

#### Archive and Extractor Example

This example reads in all the files from a folder named input, then creates a compressed archive by
creating an object with the key set to the file name, and the value to the value of the read file.
Next the archive is extracted, then the For-Each scope iterates over each extracted key/value and
writes the file to a new output folder with the key as the new file name, and the value the
corresponding extracted file content.

```xml
  <flow name="archive-extract-test" >
	<scheduler doc:name="Scheduler">
		<scheduling-strategy >
			<fixed-frequency frequency="15" timeUnit="SECONDS"/>
		</scheduling-strategy>
	</scheduler>
	<file:list doc:name="List" config-ref="File_Config" directoryPath="input"/>
	<set-payload value='#[output application/java
---
(0 to sizeOf(payload) - 1) as Array
reduce (index, acc={}) -&gt;
acc ++ { (payload[index].attributes.fileName): payload[index].payload}]' doc:name="Set Payload" />

	<compression:archive doc:name="Archive" >
		<compression:archiver>
			<compression:zip-archiver />
		</compression:archiver>
	</compression:archive>

	<compression:extract doc:name="Extract"  >
		<compression:extractor >
			<compression:zip-extractor />
		</compression:extractor>
	</compression:extract>

	<foreach doc:name="For Each"  collection="payload">
	  <file:write doc:name="Write"  config-ref="File_Config" path='#[output application/json
---
"output/" ++ (payload pluck $$)[0]]' >
	    <file:content ><![CDATA[#[output application/java --- ( payload pluck $ )[0]]]]></file:content>
	  </file:write>
	</foreach>

	<logger level="INFO" doc:name="Logger" message="#[output application/json --- payload]"/>
  </flow>
</mule>
```

#### Extractor Errors

If the content is not in the configured format, a `COMPRESSION:INVALID_ARCHIVE` error will be
thrown. For other errors that occur during the compression process, the operation throws a
`COMPRESSION:COULD_NOT_DECOMPRESS` error.

## Common Use cases

### Compress a File

This example reads a file, compresses it, and saves it.

```xml
<file:read path="file.txt"/>
<compression:compress>
   <compression:compressor>
       <compression:gzip-compressor/>
   </compression:compressor>
</compression:compress>
<file:write path="file-txt.gz"/>
```

### Decompress a Payload from a Remote Service

This example calls a server that returns and decompresses a Zip file.

```xml
<wsc:consume config="ZipServiceConfig" operation="returnsZip"/>
<compression:decompress>
   <compression:content>
      #[payload.body.zipContent]
   </compression:content>
   <compression:decompressor>
       <compression:zip-decompressor/>
   </compression:decompressor>
</compression:decompress>
```

## See Also

- [Compression Module Reference](https://docs.mulesoft.com/compression-module/2.1/compression-documentation)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=71913422861761f7074af94ac2e048615e44660efc676cd219f162edee2f52de url=/mulesoft/current/en-us/compression-module/latest/index.md -->

---
product: Compression Module
version: 2.2
is-latest-version: true
---

# Compression Module

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Compression module v2.2

Compression module supports and provides access to the most-used file archiver and compression
formats through a Mule app.

A file archiver is a computer program that combines a number of files together into one archive file
for easier transportation or storage, and most archivers employ data compression in their archive
formats to reduce the size of the final archive. However, not all compression algorithms can archive
multiple files. Some are limited to single-file data compression.

This module compresses and decompresses files for each of the available formats without losing any
of the features that the format associated algorithm provides.

To achieve this capability, the module provides the **Compress** and **Decompress** operations,
which enable you to compress and decompress a single file. Additionally, the module provides the
**Archive** and **Extract** operations to archive and extract files. You can configure these
operations with the compression or archiving strategies of your choice.

## Before You Begin

To use this connector, you must be familiar with:

- Anypoint Connectors

- Mule runtime engine (Mule)

- Elements and global elements in a Mule flow

- How to create a Mule app using Anypoint Studio

Before creating an app, you must have access to Anypoint Platform and Anypoint Studio.

## Common Use Cases For the Connector

Common use cases for Compression module include:

- Compress and decompress a file’s payload from a remote service.

- Archive and extrat files from a file folder.

For examples of these use cases, refer to
[Compression Module Examples](https://docs.mulesoft.com/compression-module/latest/compression-module-examples).

## Next Step

After you complete the prerequisites, you are ready to create an app and configure the connector
using [Anypoint Studio](https://docs.mulesoft.com/compression-module/latest/compression-module-studio-configuration).

## See Also

- [Archiving and Extracting Files](https://docs.mulesoft.com/compression-module/latest/compression-module-archive-extract)

- [Compressing and Decompressing a Single File](https://docs.mulesoft.com/compression-module/latest/compression-module-compress-decompress)

- [Compression Module Reference](https://docs.mulesoft.com/compression-module/latest/compression-documentation)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=99a9964be4286cedbfd8feaab09061f0b6ad19ceb61689ae4907be696e58841f url=/mulesoft/current/en-us/compression-module/latest/compression-module-examples.md -->

---
product: Compression Module
version: 2.2
is-latest-version: true
---

# Compression Module Examples

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Compression module examples help you compress, decompress, archive and extract files.

- [Compress and Decompress Example](https://docs.mulesoft.com/compression-module/latest/compression-module-compress-decompress-example)  
  Compress a file using the **Compress** operation and decompress a payload from a remote service
  using the **Decompress** operation.

- [Archive and Extract Example](https://docs.mulesoft.com/compression-module/latest/compression-module-archive-extract-example)  
  Archive and extrat files from a file folder using the **Archive** and **Extract** operations.

## See Also

[Salesforce Help](https://help.salesforce.com)

<!-- document id=f873c027e9ae692ce1870bddc3fa365998dafe7739370f537be2cc75783580ec url=/mulesoft/current/en-us/compression-module/2.0/compression-documentation.md -->

---
product: Compression Module
version: 2.0
---

# Compression Module Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Compression Module v2.1

A module which provides functionality for compressing and decompressing data.

Release Notes:
[Compression Module Release Notes](https://docs.mulesoft.com/release-notes/mule-runtime/module-compression)

## Configurations

---

### Config

Default configuration

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p>String</p></td><td><p>The name for this configuration. Connectors reference the configuration with this name.</p></td><td></td><td><p>x</p></td></tr></tbody></table>

## Operations

### Archive

`<compression:archive>`

Compresses all the given entries into a new file in the configured format.

Each entry passed to this operation is placed inside the compressed archive with the name provided
by the user in the DataWeave script. For example, for this expression:

`{ file: vars.aTxtContent, 'dir/resume.pdf': vars.pdf }`

The resultant archive contains two entries one named "file" at root level and another called
"resume.pdf" inside a directory called "dir"

`- Archive | \- file1 | \ dir1 | \- file2`

In this example, the slash "/" in the name of an entry indicates directory separation, so all names
are introspected to create directories inside the archive.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Entries</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Archiver</p></td><td><div><div><p>zip-archiver</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Output Encoding</p></td><td><div><div><p>String</p></div></div></td><td><p>The encoding of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configure if repeatable streams should be used and their behavior.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a variable on which the operation's output will be placed</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation's output and the outcome of that expression will be stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

#### Throws

- COMPRESSION:COULD\_NOT\_COMPRESS

### Compress

`<compression:compress>`

Compresses a given content using the configured format, ZIP or GZIP. If a problem occur while
compressing the content a COULD\_NOT\_COMPRESS error will be thrown.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Compressor</p></td><td><div><div><p>One of:</p></div><div><ul><li><p>gzip-compressor</p></li><li><p>zip-compressor</p></li></ul></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Output Encoding</p></td><td><div><div><p>String</p></div></div></td><td><p>The encoding of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configure if repeatable streams should be used and their behavior</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a variable on which the operation's output will be placed</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable</p></td><td><p>#[payload]</p></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

#### Throws

- COMPRESSION:COULD\_NOT\_COMPRESS

### Decompress

`<compression:decompress>`

Decompresses a single entry of compressed content which is assumed to be in an specific format (ZIP
or GZIP). If the content is not in the configured format, an INVALID\_ARCHIVE error is thrown.
Compressed archives can have multiple entries, this operation can handle only single entry archives
because if the archive would contain more than one the operation wouldn't know which should return,
if the content has more than one entry an TOO\_MANY\_ENTRIES error will be thrown. For multiple
entry archives use the \`extract\` operation of this module, which will let you choose only formats
that accept multiple entries.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Compressed</p></td><td><div><div><p>Binary</p></div></div></td><td></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Decompressor</p></td><td><div><div><p>One of:</p></div><div><ul><li><p>gzip-decompressor</p></li><li><p>zip-decompressor</p></li></ul></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Output Encoding</p></td><td><div><div><p>String</p></div></div></td><td><p>The encoding of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configure if repeatable streams should be used and their behavior</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a variable on which the operation's output will be placed</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable</p></td><td><p>#[payload]</p></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

#### Throws

- COMPRESSION:COULD\_NOT\_DECOMPRESS

- COMPRESSION:INVALID\_ARCHIVE

- COMPRESSION:TOO\_MANY\_ENTRIES

### Extract

`<compression:extract>`

Decompresses a given content that represent an archive in a compression format.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Compressed</p></td><td><div><div><p>Binary</p></div></div></td><td></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Extractor</p></td><td><div><div><p>One of:</p></div><div><ul><li><p>zip-extractor</p></li></ul></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configure if repeatable streams should be used and their behavior</p></td><td></td><td><p>&nbsp;</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a variable on which the operation's output will be placed</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable</p></td><td><p>#[payload]</p></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Object</p></div></div></td></tr></tbody></table>

#### Throws

- COMPRESSION:COULD\_NOT\_DECOMPRESS

- COMPRESSION:INVALID\_ARCHIVE

## Types

### Repeatable In Memory Stream

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Initial Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>This is the amount of memory to allocate to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.</p></td><td></td><td></td></tr><tr><td><p>Buffer Size Increment</p></td><td><div><div><p>Number</p></div></div></td><td><p>This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full.</p></td><td></td><td></td></tr><tr><td><p>Max Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.</p></td><td></td><td></td></tr><tr><td><p>Buffer Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><p>The unit in which all these attributes are expressed</p></td><td></td><td></td></tr></tbody></table>

### Repeatable File Store Stream

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Max In Memory Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.</p></td><td></td><td></td></tr><tr><td><p>Buffer Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><p>The unit in which maxInMemorySize is expressed</p></td><td></td><td></td></tr></tbody></table>

## See Also

[Salesforce Help](https://help.salesforce.com)

<!-- document id=ac1ae3df7396ded386a115988078a20028d498376ae00b05c076013283343e07 url=/mulesoft/current/en-us/compression-module/2.1/compression-documentation.md -->

---
product: Compression Module
version: 2.1
---

# Compression Module Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Compression Module v2.1

A module which provides functionality for compressing and decompressing data.

Release Notes:
[Compression Module Release Notes](https://docs.mulesoft.com/release-notes/mule-runtime/module-compression)

## Configurations

---

### Config

Default configuration

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p>String</p></td><td><p>The name for this configuration. Connectors reference the configuration with this name.</p></td><td></td><td><p>x</p></td></tr></tbody></table>

## Operations

### Archive

`<compression:archive>`

Compresses all the given entries into a new file in the configured format.

Each entry passed to this operation is placed inside the compressed archive with the name provided
by the user in the DataWeave script. For example, for this expression:

`{ file: vars.aTxtContent, 'dir/resume.pdf': vars.pdf }`

The resultant archive contains two entries one named "file" at root level and another called
"resume.pdf" inside a directory called "dir"

`- Archive | \- file1 | \ dir1 | \- file2`

In this example, the slash "/" in the name of an entry indicates directory separation, so all names
are introspected to create directories inside the archive.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Entries</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Archiver</p></td><td><div><div><p>zip-archiver</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Output Encoding</p></td><td><div><div><p>String</p></div></div></td><td><p>The encoding of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configure if repeatable streams should be used and their behavior.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a variable on which the operation's output will be placed</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation's output and the outcome of that expression will be stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

#### Throws

- COMPRESSION:COULD\_NOT\_COMPRESS

### Compress

`<compression:compress>`

Compresses a given content using the configured format, ZIP or GZIP. If a problem occur while
compressing the content a COULD\_NOT\_COMPRESS error will be thrown.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Compressor</p></td><td><div><div><p>One of:</p></div><div><ul><li><p>gzip-compressor</p></li><li><p>zip-compressor</p></li></ul></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Output Encoding</p></td><td><div><div><p>String</p></div></div></td><td><p>The encoding of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configure if repeatable streams should be used and their behavior</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a variable on which the operation's output will be placed</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable</p></td><td><p>#[payload]</p></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

#### Throws

- COMPRESSION:COULD\_NOT\_COMPRESS

### Decompress

`<compression:decompress>`

Decompresses a single entry of compressed content which is assumed to be in an specific format (ZIP
or GZIP). If the content is not in the configured format, an INVALID\_ARCHIVE error is thrown.
Compressed archives can have multiple entries, this operation can handle only single entry archives
because if the archive would contain more than one the operation wouldn't know which should return,
if the content has more than one entry an TOO\_MANY\_ENTRIES error will be thrown. For multiple
entry archives use the \`extract\` operation of this module, which will let you choose only formats
that accept multiple entries.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Compressed</p></td><td><div><div><p>Binary</p></div></div></td><td></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Decompressor</p></td><td><div><div><p>One of:</p></div><div><ul><li><p>gzip-decompressor</p></li><li><p>zip-decompressor</p></li></ul></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>The MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Output Encoding</p></td><td><div><div><p>String</p></div></div></td><td><p>The encoding of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configure if repeatable streams should be used and their behavior</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a variable on which the operation's output will be placed</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable</p></td><td><p>#[payload]</p></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

#### Throws

- COMPRESSION:COULD\_NOT\_DECOMPRESS

- COMPRESSION:INVALID\_ARCHIVE

- COMPRESSION:TOO\_MANY\_ENTRIES

### Extract

`<compression:extract>`

Decompresses a given content that represent an archive in a compression format.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Compressed</p></td><td><div><div><p>Binary</p></div></div></td><td></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Extractor</p></td><td><div><div><p>One of:</p></div><div><ul><li><p>zip-extractor</p></li></ul></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configure if repeatable streams should be used and their behavior</p></td><td></td><td><p>&nbsp;</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a variable on which the operation's output will be placed</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression that will be evaluated against the operation's output and the outcome of that expression will be stored in the target variable</p></td><td><p>#[payload]</p></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Object</p></div></div></td></tr></tbody></table>

#### Throws

- COMPRESSION:COULD\_NOT\_DECOMPRESS

- COMPRESSION:INVALID\_ARCHIVE

## Types

### Repeatable In Memory Stream

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Initial Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>This is the amount of memory to allocate to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.</p></td><td></td><td></td></tr><tr><td><p>Buffer Size Increment</p></td><td><div><div><p>Number</p></div></div></td><td><p>This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full.</p></td><td></td><td></td></tr><tr><td><p>Max Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.</p></td><td></td><td></td></tr><tr><td><p>Buffer Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><p>The unit in which all these attributes are expressed</p></td><td></td><td></td></tr></tbody></table>

### Repeatable File Store Stream

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Max In Memory Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.</p></td><td></td><td></td></tr><tr><td><p>Buffer Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><p>The unit in which maxInMemorySize is expressed</p></td><td></td><td></td></tr></tbody></table>

## See Also

[Salesforce Help](https://help.salesforce.com)

<!-- document id=47f2c913851850916a73b0902a0703aaf0f7e4d9b4041f172574508879f12d4f url=/mulesoft/current/en-us/compression-module/latest/compression-documentation.md -->

---
product: Compression Module
version: 2.2
is-latest-version: true
---

# Compression Module Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Compression Module v2.2

A module which provides functionality for compressing and decompressing data.

Release Notes:
[Compression Module Release Notes](https://docs.mulesoft.com/release-notes/mule-runtime/module-compression)

## Configurations

---

### Config

Default configuration

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p>String</p></td><td><p>The name for this configuration. Connectors reference the configuration with this name.</p></td><td></td><td><p>x</p></td></tr></tbody></table>

## Operations

### Archive

`<compression:archive>`

Compresses all the given entries into a new file in the configured format.

Each entry passed to this operation is placed inside the compressed archive with the entry name you
provide in the DataWeave script. For example, for the following expression:

`{ file: vars.aTxtContent, 'dir/resume.pdf': vars.pdf }`

The resultant archive contains two entries: `file`, located at the root level, and `resume.pdf`,
located in the `dir` directory.

`- Archive | \- file1 | \ dir1 | \- file2`

In this example, the slash `/` in the name of an entry indicates a directory separation. All names
create directories inside the archive.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Entries</p></td><td><div><div><p>Object</p></div></div></td><td><p>Entries to add to the archive file.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Archiver</p></td><td><div><div><p><a href="#zip-archiver">Zip Archiver</a></p></div></div></td><td><p>Archiver strategy that compresses multiple entries into an archive.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Output Encoding</p></td><td><div><div><p>String</p></div></div></td><td><p>Encoding of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p><a href="#non-repeatable-stream">Non-repeatable Stream</a></p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

#### Throws

- COMPRESSION:COULD\_NOT\_COMPRESS

### Compress

`<compression:compress>`

Compresses a given content using the configured format `Zip` or `GZip`.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>Content to compress.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Compressor</p></td><td><div><div><p>One of:</p></div><div><ul><li><p>gzip-compressor</p></li><li><p><a href="#zip-compressor">Zip Compressor</a></p></li></ul></div></div></td><td><p>Compressor strategy that compresses a file or a single-entry archive.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Output Encoding</p></td><td><div><div><p>String</p></div></div></td><td><p>Encoding of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p><a href="#non-repeatable-stream">Non-repeatable Stream</a></p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

#### Throws

- COMPRESSION:COULD\_NOT\_COMPRESS

### Decompress

`<compression:decompress>`

Decompresses a single entry of compressed content in the configured format of `Zip` or `GZip`.
Compressed archives can have multiple entries. The **Decompress** operation manages only
single-entry archives because if the archive contains more than one entry, the operation does not
know which entry to return. For multiple entry archives, use this module’s **Extract** operation,
which enables you to select only formats that accept multiple entries.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Compressed</p></td><td><div><div><p>Binary</p></div></div></td><td><p>Content to decompress.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr><tr><td><p>Decompressor</p></td><td><div><div><p>One of:</p></div><div><ul><li><p>gzip-decompressor</p></li><li><p>zip-decompressor</p></li></ul></div></div></td><td><p>Decompressor strategy that decompress a file or a single-entry archive.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Output Encoding</p></td><td><div><div><p>String</p></div></div></td><td><p>Encoding of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p><a href="#non-repeatable-stream">Non-repeatable Stream</a></p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

#### Throws

- COMPRESSION:COULD\_NOT\_DECOMPRESS

- COMPRESSION:INVALID\_ARCHIVE

- COMPRESSION:TOO\_MANY\_ENTRIES

### Extract

`<compression:extract>`

Decompresses a given content that represent an archive in a compression format.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Compressed</p></td><td><div><div><p>Binary</p></div></div></td><td><p>Compressed archive content to decompress.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Extractor</p></td><td><div><div><p>One of:</p></div><div><ul><li><p>zip-extractor</p></li></ul></div></div></td><td><p>Extractor strategy that decompresses an archive with multiple entries that are compressed in a particular format.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p><a href="#non-repeatable-stream">Non-repeatable Stream</a></p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p><code>#[payload]</code></p></td><td></td></tr></tbody></table>

#### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p><strong>Type</strong></p></td><td><div><div><p>Object</p></div></div></td></tr></tbody></table>

#### Throws

- COMPRESSION:COULD\_NOT\_DECOMPRESS

- COMPRESSION:INVALID\_ARCHIVE

## Types

### Repeatable In Memory Stream

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Initial Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>This is the amount of memory to allocate to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.</p></td><td></td><td></td></tr><tr><td><p>Buffer Size Increment</p></td><td><div><div><p>Number</p></div></div></td><td><p>This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full.</p></td><td></td><td></td></tr><tr><td><p>Max Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.</p></td><td></td><td></td></tr><tr><td><p>Buffer Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><p>The unit in which all these attributes are expressed</p></td><td></td><td></td></tr></tbody></table>

### Repeatable File Store Stream

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Max In Memory Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.</p></td><td></td><td></td></tr><tr><td><p>Buffer Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><p>The unit in which maxInMemorySize is expressed</p></td><td></td><td></td></tr></tbody></table>

### Non-repeatable Stream

Disables the repeatable stream functionality and uses non-repeatable streams to have less
performance overhead, memory use, and cost.

### Zip Compressor

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Force Zip64</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Enables you to compress files and byte arrays greater than 4 GB.</p></td><td><p>false</p></td><td></td></tr></tbody></table>

### Zip Archiver

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Force Zip64</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Enables you to archive files and byte arrays greater than 4 GB.</p></td><td><p>false</p></td><td></td></tr></tbody></table>

## See Also

[Salesforce Help](https://help.salesforce.com)

<!-- document id=1566ebb8cff1d30e498f6ace3939184216467136d08eb9ed33d926c712e2a1fa url=/mulesoft/current/en-us/compression-module/2.1/compression-xml-maven.md -->

---
product: Compression Module
version: 2.1
---

# Compression Module XML and Maven Support

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio.

If you manually code a Mule runtime engine (Mule) app in XML, either from the Anypoint Studio XML
editor or from a text editor, you can get access to the connector in your app by adding reference
statements to both your XML Mule flow and the Apache Maven `pom.xml` file.

When you add the connector in Studio, Studio automatically populates the XML code with the
connector’s namespace and schema location. It also adds a dependency to the `pom.xml` file.

## Add a Namespace for the Connector

Paste the following code inside the `<mule>` tag of the header of your configuration XML:

```xml
http://www.mulesoft.org/schema/mule/compression
http://www.mulesoft.org/schema/mule/compression/current/mule-compression.xsd
```

This example shows how the namespace statements are placed in the `<mule>` XML block:

```xml
<mule xmlns:compression="http://www.mulesoft.org/schema/mule/compression"
	xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns:file="http://www.mulesoft.org/schema/mule/file"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core
	http://www.mulesoft.org/schema/mule/core/current/mule.xsd
	http://www.mulesoft.org/schema/mule/file
	http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd
	http://www.mulesoft.org/schema/mule/http
	http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
	http://www.mulesoft.org/schema/mule/ee/core
	http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
	http://www.mulesoft.org/schema/mule/compression
	http://www.mulesoft.org/schema/mule/compression/current/mule-compression.xsd">
```

## Add a POM File Dependency

The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app.
If you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to
this connector:

```xml
<dependency>
  <groupId>org.mule.modules</groupId>
  <artifactId>mule-compression-module</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

Replace `x.x.x` with the version that corresponds to the connector you are using.

To obtain the most up-to-date `pom.xml` file information:

1.  Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/).

2.  In Exchange, click **Login** and supply your Anypoint Platform username and password.

3.  In Exchange, search for `compression`.

4.  Select the connector.

5.  Click **Dependency Snippets** near the upper right of the screen.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=184606f690562306a95ffab63a9cf422e56b472ecfa6f6b5271654f3035cfea3 url=/mulesoft/current/en-us/compression-module/latest/compression-xml-maven.md -->

---
product: Compression Module
version: 2.2
is-latest-version: true
---

# Compression Module XML and Maven Support

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio.

If you manually code a Mule runtime engine (Mule) app in XML, either from the Anypoint Studio XML
editor or from a text editor, you can get access to the connector in your app by adding reference
statements to both your XML Mule flow and the Apache Maven `pom.xml` file.

When you add the connector in Studio, Studio automatically populates the XML code with the
connector’s namespace and schema location. It also adds a dependency to the `pom.xml` file.

## Add a Namespace for the Connector

Paste the following code inside the `<mule>` tag of the header of your configuration XML:

```xml
http://www.mulesoft.org/schema/mule/compression
http://www.mulesoft.org/schema/mule/compression/current/mule-compression.xsd
```

This example shows how the namespace statements are placed in the `<mule>` XML block:

```xml
<mule xmlns:compression="http://www.mulesoft.org/schema/mule/compression"
	xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
	xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns:file="http://www.mulesoft.org/schema/mule/file"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core
	http://www.mulesoft.org/schema/mule/core/current/mule.xsd
	http://www.mulesoft.org/schema/mule/file
	http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd
	http://www.mulesoft.org/schema/mule/http
	http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
	http://www.mulesoft.org/schema/mule/ee/core
	http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd
	http://www.mulesoft.org/schema/mule/compression
	http://www.mulesoft.org/schema/mule/compression/current/mule-compression.xsd">
```

## Add a POM File Dependency

The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app.
If you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to
this connector:

```xml
<dependency>
  <groupId>org.mule.modules</groupId>
  <artifactId>mule-compression-module</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

Replace `x.x.x` with the version that corresponds to the connector you are using.

To obtain the most up-to-date `pom.xml` file information:

1.  Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/).

2.  In Exchange, click **Login** and supply your Anypoint Platform username and password.

3.  In Exchange, search for `compression`.

4.  Select the connector.

5.  Click **Dependency Snippets** near the upper right of the screen.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=e73e96abb743d0f14ccf6e4abfee1d968724ea5c8b2adb03ef2680b8ea951a92 url=/mulesoft/current/en-us/compression-module/2.1/compression-module-troubleshooting.md -->

---
product: Compression Module
version: 2.1
---

# Troubleshooting Compression Module

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

To troubleshoot Compression module, become familiar with the information about enabling verbose
logging and interpreting commonly thrown messages.

## Enable Verbose Logging

To get a better understanding of why an application’s interaction with the Compression module is
failing, temporarily enable verbose logging for the module.

Remember to always disable the enhanced verbosity after troubleshooting, because it affects your
Mule application performance.

To enable verbose logging in the configuration file:

1.  Access Anypoint Studio and navigate to the **Package Explorer** view.

2.  Open your application’s project name.

3.  Open the `src/main/resources` path folder.

4.  Open the `log4j2.xml` file inside the folder.

5.  Add an `<AsyncLogger>` tag inside the `<Loggers>` tag:

    ```xml
    			<Loggers>
    				...
    				<AsyncLogger name="org.mule.extension.compression" level="DEBUG"/>
    				<AsyncLogger name="org.apache.commons.compress" level="DEBUG"/>
    				...
    			</Loggers>
    ```

6.  Save your application changes.

7.  Click the project name in **Package Explorer** and then click **Run** > **Run As** > **Mule
    Application**.

## Understand Common Throws

Here is a list of common throw messages and how to interpret them:

- COMPRESSION:COULD\_NOT\_COMPRESS

An error occurred while trying to compress content.

- COMPRESSION:COULD\_NOT\_DECOMPRESS

An error occurred while trying to decompress content.

- COMPRESSION:INVALID\_ARCHIVE

The content to decompress is an invalid archive.

- COMPRESSION:TOO\_MANY\_ENTRIES

When an archive with multiple entries passes to the **Decompress** operation, the module is unable
to choose only one entry.

## See Also

- [Salesforce Help](https://help.salesforce.com)

- [Compression Module Reference](https://docs.mulesoft.com/compression-module/2.1/compression-documentation)

<!-- document id=c98ca8a1341af1634f162a294965cfdf814789f45b8266d53a1d281838867fd8 url=/mulesoft/current/en-us/compression-module/latest/compression-module-troubleshooting.md -->

---
product: Compression Module
version: 2.2
is-latest-version: true
---

# Troubleshooting Compression Module

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

To troubleshoot Compression module, become familiar with the information about enabling verbose
logging and interpreting commonly thrown messages.

## Enable Verbose Logging

To get a better understanding of why an application’s interaction with the Compression module is
failing, temporarily enable verbose logging for the module.

Remember to always disable the enhanced verbosity after troubleshooting, because it affects your
Mule application performance.

To enable verbose logging in the configuration file:

1.  Access Anypoint Studio and navigate to the **Package Explorer** view.

2.  Open your application’s project name.

3.  Open the `src/main/resources` path folder.

4.  Open the `log4j2.xml` file inside the folder.

5.  Add an `<AsyncLogger>` tag inside the `<Loggers>` tag:

    ```xml
    			<Loggers>
    				...
    				<AsyncLogger name="org.mule.extension.compression" level="DEBUG"/>
    				<AsyncLogger name="org.apache.commons.compress" level="DEBUG"/>
    				...
    			</Loggers>
    ```

6.  Save your application changes.

7.  Click the project name in **Package Explorer** and then click **Run** > **Run As** > **Mule
    Application**.

## Understand Common Throws

Here is a list of common throw messages and how to interpret them:

- COMPRESSION:COULD\_NOT\_COMPRESS

An error occurred while trying to compress content.

- COMPRESSION:COULD\_NOT\_DECOMPRESS

An error occurred while trying to decompress content.

- COMPRESSION:INVALID\_ARCHIVE

The content to decompress is an invalid archive.

- COMPRESSION:TOO\_MANY\_ENTRIES

When an archive with multiple entries passes to the **Decompress** operation, the module is unable
to choose only one entry.

## See Also

- [Compression Module Reference](https://docs.mulesoft.com/compression-module/latest/compression-documentation)

- [Salesforce Help](https://help.salesforce.com)

- [Known Issues](https://help.salesforce.com/s/issues)

<!-- document id=f502274015bbe96be785ce1c6452a0f6e15a0320a2b036edb8ce5e1f133dc38e url=/mulesoft/current/en-us/compression-module/latest/compression-module-studio-configuration.md -->

---
product: Compression Module
version: 2.2
is-latest-version: true
---

# Using Anypoint Studio to Configure Compression Module 2.2

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and
configuration files.

To add and configure a connector in Studio:

1.  [Create a Mule project](#create-mule-project).

2.  [Add the connector to your Mule project](#add-connector-to-project).

3.  [Configure a source for the connector’s flow](#configure-source).

4.  [Add a connector operation to the flow](#add-connector-operation).

When you run the connector, you can view the app log to check for problems in real time, as
described in [View the App Log](#view-app-log).

If you are new to configuring connectors in Studio, see
[Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio).
If, after reading this topic, you need additional information about the connector fields, see the
[Compression Module Reference](https://docs.mulesoft.com/compression-module/latest/compression-documentation).

## Create a Mule Project

In Studio, create a new Mule project in which to add and configure the connector:

1.  In Studio, select **File > New > Mule Project**.

2.  Enter a name for your Mule project and click **Finish**.

## Add the Connector to Your Mule Project

Add Compression module to your Mule project to automatically populate the XML code with the
connector’s namespace and schema location and add the required dependencies to the project’s
`pom.xml` file:

1.  In **Mule Palette**, click **(X) Search in Exchange**.

2.  In **Add Dependencies to Project**, type `connector-template-files` in the search field.

3.  Click Compression Module in **Available modules**.

4.  Click **Add**.

5.  Click **Finish**.

Adding a connector to a Mule project in Studio does not make that connector available to other
projects in your Studio workspace.

## Configure a Source

A source initiates a flow when a specified condition is met. You can configure one of these sources
to use with Compression module:

- HTTP Listener  
  Initiates a flow each time it receives a request on the configured host and port

- Scheduler  
  Initiates a flow when a time-based condition is met

For example, to configure an HTTP Listener source, follow these steps:

1.  In **Mule Palette**, select **HTTP > Listener**.

2.  Drag **Listener** to the Studio canvas.

3.  On the **Listener** configuration screen, optionally change the value of the **Display Name**
    field.

4.  Specify a value for the **Path** field.

5.  Click the plus sign (**+**) next to the **Connector configuration** field to configure a global
    element that can be used by all instances of the HTTP Listener source in the app.

6.  On the **General** tab, specify connection information for the connector.

7.  On the **TLS** tab, optionally specify the TLS information for the connector.

8.  On the **Advanced** tab, optionally specify reconnection information, including a reconnection
    strategy.

9.  Click **Test Connection** to confirm that Mule can connect with the specified server.

10. Click **OK**.

## Add a Connector Operation to the Flow

When you add a connector operation to your flow, you are specifying an action for that connector to
perform.

To add an operation for Compression module, follow these steps:

1.  In **Mule Palette**, select **Compression** and then select the desired operation.

2.  Drag the operation onto the Studio canvas, next to the input source.

![Compression module operations in Mule palette](/mulesoft/current/en-us/compression-module/latest/_images/compression-module-operations.png)

## View the App Log

To check for problems, you can view the app log as follows:

- If you’re running the app from Anypoint Platform, the app log output goes to the Anypoint Studio
  console window.

- If you’re running the app using Mule from the command line, the app log output goes to your
  operating system console.

Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also access the
app log in the default location `MULE_HOME/logs/<app-name>.log`. You can configure the location of
the log path in the app log file `log4j2.xml`.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)

- [Compression Module Reference](https://docs.mulesoft.com/compression-module/latest/compression-documentation)

- [Salesforce Help](https://help.salesforce.com)