---
title: 'File Extractor'
url: 'https://docs.brix.ch/celum_extensions/file_extractor'
markdown: 'https://docs.brix.ch/celum_extensions/file_extractor.md'
lang: en
date: '2026-10-26'
description: 'Technical documentation for the CELUM Extension "File Extractor" – Software developed by brix'
taxonomy:
  category:
    - docs
---

[](#) 

  [ Welcome ](https://docs.brix.ch/)     [ CELUM Extensions ](https://docs.brix.ch/celum_extensions)      File Extractor    

# File Extractor

![Advanced-UI](https://img.shields.io/static/v1?label=UI&message=Advanced&color=lightgrey)![NOVA-UI](https://img.shields.io/static/v1?label=UI&message=NOVA&color=blue)

The plugin extracts the files in a zip file and creates a node (permission-defining) for all folders, and an asset for all contained files.

The following precondition must be met for the zip to be unpacked:

- The user must have sufficient permissions in the target node (add node, add asset and delete asset if applicable).
- The target node must not be a strict node.
- The target node must be permission defining.
- It must be possible to determine a unique target node (in case of multiple parent nodes).

#### Table of Contents

- [Properties](#properties)
- [Compatibility Matrix](#compatibility-matrix)
- [Release Notes](#release-notes)

## Properties

To be configured in {home}/appserver/conf/custom.properties

##### fileExtractor.license

> type: String, **required: yes**, default: -

The license key for the plugin (product: fileExtractor), provided by brix.

##### fileExtractor.visibleForGroups

> type: list of long (comma separated), required: no, default: -

Restrict the use of the plugin to this user group's IDs (superadmins always see it in any case). If not set, all users can see the menu items.

##### fileExtractor.blacklist

> type: Regex, required: no, default: ^\[\\.\].\*|Thumbs.db$

A blacklist of file names to ignore. Defaults to dot-files and the ungodly Thumbs.db

##### fileExtractor.defaultAssetTypeId

> type: long, required: no, default: -

Default asset type for extracted assets.

##### fileExtractor.deleteZipFile

> type: boolean, required: no, default: true

Determines whether the zip file is deleted after extracting.

##### fileExtractor.autoExtract

> type: boolean, required: no, default: false

Determines whether released zip files are extracted automatically.

##### fileExtractor.unzipInTargetNode (since: 1.2.0)

> type: boolean, required: no, default: false

Determines whether the zip file contents are extracted directly into the target node instead of creating a node named after the zip file.

## Compatibility Matrix

| File Extractor | CELUM (min. version) |
|---|---|
| 1.0.3 | 6.4 (tested with 6.11) |
| 1.2.0 | 6.20 (tested with 6.20) |
| 1.3 | 7.1 |

| Nova Plugin | CELUM (min. version) | Backend Plugin (min. version) |
|---|---|---|
| 1.0.1-6.11.0 | 6.11.0 | 1.0.3 |
| 1.0.0-6.12.0 | 6.12.0 | 1.0.3 |
| 1.1 | 7.1 | 1.3 |

## Release Notes

#### 1.0.3

> Release: 2022-08-05

Initial Version

#### 1.2.0

> Release: 2026-07-01

unzipInTargetNode

#### 1.3

> Release: 2026-08-05

Compatibility with CELUM 7.1

 [ ](https://docs.brix.ch/celum_extensions/gdpr_api) [](https://docs.brix.ch/celum_extensions/carbon_copy_plus)

---

## Navigation

- Parent: [CELUM Extensions](https://docs.brix.ch/celum_extensions.md)
- Previous: [GDPR API](https://docs.brix.ch/celum_extensions/gdpr_api.md)
- Next: [Carbon Copy Plus (Premium)](https://docs.brix.ch/celum_extensions/carbon_copy_plus.md)