# Zip file

## ![](/files/xx667pIpggQL6EVrM9Fx) Zip file

### Description <a href="#description" id="description"></a>

The Zip File transform creates a standard ZIP archive using the options you specify in the dialog.

| Hop Engine | <sup>✓</sup> |
| ---------- | ------------ |
| Spark      | ?            |
| Flink      | ?            |
| Dataflow   | ?            |

### Options

| Option                      | Description                                                                                                                                                                                                                                                                                                                 |
| --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Transform name              | Name of the transform.                                                                                                                                                                                                                                                                                                      |
| Create target parent folder | Check this option to create the target parent folder if needed.                                                                                                                                                                                                                                                             |
| Overwrite target file       | Check this option to overwrite the target file if it exists.                                                                                                                                                                                                                                                                |
| Add zip filename to result  | Check this option to add the zip filename to the internal result set.                                                                                                                                                                                                                                                       |
| Source filename field       | Define the field that contains the source filename. This is the file that gets added to the zip archive.                                                                                                                                                                                                                    |
| Target filename field       | Define the field that contains the target zip filename. This file is created if it does not exist, or overwritten if you allow it.                                                                                                                                                                                          |
| Keep source folders         | Check this option to keep the source folder in the zip file’s name.                                                                                                                                                                                                                                                         |
| Base folder fieldname       | If Keep source folders is selected, define a field that contains any additional folders the source folder is nested in, which will be removed from the file name when the zip file is created. This preserves only the name of the folder the file was in as part of the zip file name, such as 'outputs/result.zip'        |
| After zip                   | <p>The action to take on the source file after zipping. Select one of the following:</p><p>\*Do nothing: The source file is left in the folder. \*Move source file: Moves the source file to the location specified in the Move to folder fieldname box. \*Delete source file: Deletes the source file from the folder.</p> |
| Move to folder fieldname    | Define the field that contains the target folder to move the source file to after zipping.                                                                                                                                                                                                                                  |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.primeur.com/data-shaper-1.21/knowing-the-data-shaper-designer/pipelines/transforms/zipfile.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
