X4 Produktdokumentation
X4 Produktdokumentation
Breadcrumbs

Operation: Zip

Mit der Operation Zip des ZIP Converters komprimieren Sie den bereitgestellten Input in einer Zip-Datei. Es können Verschlüsselungs- und Komprimierungseinstellungen vorgenommen werden.

Parameter

sourcePath

Verzeichnispfad zur Datei, die komprimiert/dekomprimiert werden soll.

Hinweis:

Wenn Sie diesen Parameter nicht setzen, dann wird die Datei über den Adapter-Input bereitgestellt. In diesem Fall müssen Sie einen Wert für den Parameter inputName festlegen.

Mögliche Werte:

Verzeichnispfad

targetPath

Verzeichnispfad zum Speicherort, an dem der Output gespeichert werden soll ("Zielverzeichnis").

Hinweis:

Wenn dieser Parameter nicht gesetzt wird, dann wird die Datei über den Adapter-Output bereitgestellt.

Mögliche Werte:

Verzeichnispfad

overwrite

Legt fest, ob vorhandene Dateien mit dem gleichen Namen überschrieben werden sollen.

Mögliche Werte:

  • true: Dateien werden überschrieben.

Hinweise zu aktiviertem Kontrollkästchen (true):

  • Wenn mergeContent aktiviert ist, dann wird im Output eine Fehlermeldung ausgegeben, da die Datei nicht weiterverarbeitet werden kann.

  • Wenn mergeContent deaktiviert ist, dann wird die vorhandene Datei überschrieben.

  • false: Dateien werden nicht überschrieben.

Hinweise zu deaktiviertem Kontrollkästchen (false):

  • Wenn mergeContent aktiviert ist, dann wird werden die Dateien zusammengeführt.

  • Wenn mergeContent deaktiviert ist, dann wird im Output eine Fehlermeldung ausgegeben, da die Datei nicht weiterverarbeitet werden kann.

mergeContent

Legt fest, ob vorhandene Dateien mit dem gleichen Namen zusammengeführt werden sollen.

Mögliche Werte:

  • true: Dateien werden zusammengeführt.

Hinweise zu aktiviertem Kontrollkästchen (true):

  • Wenn overwrite aktiviert ist, dann wird im Output eine Fehlermeldung ausgegeben, da die Datei nicht weiterverarbeitet werden kann.

  • Wenn overwrite deaktiviert ist, dann werden die Dateien zusammengeführt.

  • false: Dateien werden nicht zusammengeführt.

Hinweise zu deaktiviertem Kontrollkästchen (false):

  • Wenn overwrite aktiviert ist, dann wird die vorhandene Datei überschrieben.

  • Wenn overwrite deaktiviert ist, dann wird im Output eine Fehlermeldung ausgegeben, da die Datei nicht weiterverarbeitet werden kann.

inputName

Name der Input-Datei. Wird verwendet, wenn der sourcePath nicht gesetzt ist.

Mögliche Werte:

Dateiname der Datei, die als Input empfangen bzw. als Output ausgegeben werden soll

includeRootFolder

Legt fest, ob das Root-Verzeichnis des zu zippenden Pfads in der ZIP-Datei enthalten sein soll.

Hinweis:

Dieser Parameter funktioniert nur beim Zippen eines Ordners. Wenn Sie eine einzelne Datei zippen und den Parameter setzen, hat der Parameter keinen Effekt.

Mögliche Werte:

  • true: Das Root-Verzeichnis des zu zippenden Pfads ist in der ZIP-Datei enthalten.
    Beispiel: Wenn Sie den Pfad C:/Users/MyUser/Downloads/ZipMe angeben, wird der Ordner ZipMe inklusive aller Kindobjekte gezippt.

  • false: Das Root-Verzeichnis des zu zippenden Pfads ist nicht in der ZIP-Datei enthalten.
    Beispiel: Wenn Sie den Pfad C:/Users/MyUser/Downloads/ZipMe angeben, werden nur die Kindobjekte des Ordners ZipMe gezippt.

encryptedFiles

Gibt an, ob in der Operation verschlüsselte Dateien verarbeitet werden sollen. Bei der Operation Zip wird die ausgegebene Zip-Datei passwortgeschützt.

Mögliche Werte:

  • true

  • false

password

Passwort für verschlüsselte Dateien.

Mögliche Werte:

Beliebige Zeichenkette

encryptionMethod

Gibt an, welche Verschlüsselungsmethode beim Zippen verwendet wird, wenn encryptedFiles aktiviert ist.

Mögliche Werte:

  • No encryption: Keine Verschlüsselung beim Zippen verwenden

  • AES: AES-Verschlüsselungsalgorithmus verwenden (Schlüssellänge: 256 Bit)

  • Standard: Standard-Verschlüsselungsalgorithmus verwenden

compressionMethod

Gibt an, welcher Komprimierungsalgorithmus beim Zippen verwendet wird.

Mögliche Werte:

  • Deflate (Standard): Verlustfreie Komprimierung, die eine Kombination aus dem LZ77-Algorithmus und Huffman-Codierung verwendet.

Hinweise zum Wert Deflate:

  • Store: Daten werden nicht komprimiert, sondern in eine einzige Datei gepackt.

Hinweis zum Wert Store:

Dieser Wert ist nützlich, wenn mehrere Daten/Ordner gesendet/empfangen werden sollen und die Dateigröße vernachlässigt werden kann. Es wird keine Zeit für das Verpacken benötigt.

compressionLevel

Gibt den Komprimierungsalgorithmus beim Zippen an, wenn Der Wert Deflate als compressionMethod gewählt ist.

Mögliche Werte:

  • Fastest: Niedrigste Kompressionsstufe, aber sehr schnelle Kompression

  • Fast: Niedrige Kompressionsstufe, aber schnelle Kompression

  • Normal (Standard): Optimales Verhältnis zwischen Kompressionsstufe und Geschwindigkeit

  • Maximum: Hohe Kompressionsstufe, aber langsamere Kompression

  • Ultra: Höchste Kompressionsstufe, aber sehr langsame Kompression

Statuswerte

1

Die Operation wurde erfolgreich ausgeführt

-1

Die Operation ist aufgrund eines technischen Fehlers fehlgeschlagen.

Input

Abhängig von der Konfiguration des Parameters sourcePath erwartet der Adapter unterschiedlichen Input.

  • Wenn der Parameter sourcePath nicht gesetzt ist, wird der Input des Adapters gezipped.

  • Wenn der Parameter sourcePath gesetzt ist, werden die Datei(en) im sourcePath gezipped und der Adapter erwartet keinen spezifischen Input.

Output

Abhängig von der Konfiguration des Parameters targetPath liefert der Adapter unterschiedlichen Output zurück.

  • Wenn der Parameter targetPath nicht gesetzt ist, wird eine ZIP-Datei ausgegeben.

  • Wenn der Parameter targetPath gesetzt ist, wird das Ergebnis der Operation am Speicherort abgelegt, der als Verzeichnispfad angegeben ist.