FTP Connector | X4Documentation

Der Adapter unterstützt die Protokolle FTP (File Transfer Protocol), SFTP (SSH File Transfer Protocol) und FTPS (File Transfer Protocol Secure bzw. FTP-SSL) zum Senden, Empfangen, Löschen und Verschieben von einer Datei oder einem Ordner sowie zum Auflisten von Ordnerinhalten. Der Adapter unterstützt Proxy-Server vom Typ HTTP, SOCKS4 und SOCKS5.

Hinweis:

Dieser Funktions-Adapter ersetzt den FTP Transfer sowie den SFTP Communication Adapter.

Eigenschaften (Properties)

Operation

Bestimmt, welche Dateitransfer-Operation mit den verarbeiteten Dateien oder Ordnern durchgeführt wird.

Mögliche Werte:

Exists: Prüfen, ob die im Parameter path festgelegten Dateien oder Ordner existieren. Gibt als Ergebnis eine XML mit Metadaten aus.
List: Namen und Metadaten von Dateien und Ordnern aus dem im Parameter path festgelegten Ordner auflisten. Gibt als Ergebnis eine XML mit Metadaten aus.

Der Inhalt der Dateien wird nicht gelistet.
Send File: Daten aus dem vorangegangenen Prozess-Schritt in die im Parameter path angegebene Zieldatei schreiben.
Receive File: Im Parameter path festgelegte Datei lesen.
Append File: Datei aus dem vorangegangenen Prozess-Schritt in die im Parameter path angegebenen Zieldatei anhängen.
Move: Datei oder Ordner auf dem FTP(S)/SFTP-Server von path nach targetPath verschieben.
Delete File: Im Parameter path festgelegte Dateien löschen.
Create Folder: Im Parameter path festgelegten Ordner auf dem FTP(S)/SFTP-Server erstellen.
Delete Folder: Im Parameter path festgelegten Ordner löschen.

Parameter

`host`	IP-Adresse oder Host-Name des FTP(S)/SFTP-Servers Mögliche Werte: Beliebige gültige Zeichenkette (z.B. `server.tld`)
`port`	Port-Nummer des FTP(S)/SFTP-Servers Mögliche Werte: Beliebige positive ganze Zahl `22`: SFTP-Standardport (Standard)
`user`	Benutzername für die FTP(S)/SFTP-Verbindung
`password`	Passwort für die FTP(S)/SFTP-Verbindung
`path`	Pfad zu einem Ordner oder einer Datei auf dem FTP(S)/SFTP-Server Mögliche Werte: Beliebige Zeichenkette (z.B. `/Folder/Subfolder` oder `/Folder/Subfolder/File.xml` )
`targetPath`	Zusätzlicher Pfad zu einem Ordner oder einer Datei auf dem FTP(S)/SFTP-Server Dieser Parameter wird nur bei der Operation `Move` verwendet. Mögliche Werte: Beliebige Zeichenkette (z.B. `/Folder/Subfolder` oder `/Folder/Subfolder/File.xml` )
`protocol`	Dateitransfer-Protokoll Mögliche Werte: `FTP`: Operationen über das File Transfer Protocol ausführen (Standard) `FTPS`: Operationen über das File Transfer Protocol Secure ausführen `SFTP`: Operationen über das SSH File Transfer Protocol ausführen
`connectMode`	Verbindungsmodus Mögliche Werte: `ACTIVE`: Aktiver Verbindungmodus `PASSIVE`: Passiver Verbindungsmodus (standard)
`nameFilter`	Filtert den Output der Operation `List` nach Name Mögliche Werte: Beliebige Zeichenkette (z.B. `.xml` ) Platzhalter (Wildcard) `*`
`addNewLine`	Fügt in der Zieldatei eine neue Zeile vor der anzuhängenden Datei ein. Kann nur mit der Operation `Append File` verwendet werden. Mögliche Werte: `None`: (Standard) Fügt keine neue Zeile ein. `Auto`: Fügt eine neue Zeile ein, wenn zuvor keine neue Zeile eingefügt wurde. Erkennt das Format einer bereits eingefügten neuen Zeile. `Windows`: Fügt eine neue Zeile im Windows-Format ein. `Unix`: Fügt eine neue Zeile im Unix-Format ein.
`hostValidationEnabled`	Host-Validierung aktivieren, um sicherzustellen, dass der angefragte SFTP-Server auch dem SFTP-Server entspricht, mit dem verbunden wird. Der Parameter `hostValidationEnabled` ist nur für das SFTP-Protokoll relevant. Mögliche Werte: `Ja`: Host-Validierung aktivieren (Flag setzen) `Nein`: Host-Validierung deaktivieren (nicht empfohlen für Produktivsysteme) (Standard)
`hostValidationFile`	Pfad zur Known Hosts-Datei, die eine Liste von bestätigten Hosts und deren zugehörigen Public Keys enthält. Mögliche Werte: Beliebiger gültiger Pfad (z.B. `C:\Data\known_hosts)`

Statuswerte

`1`	Die Operation wurde erfolgreich ausgeführt.
`-1`	Die Operation ist aufgrund eines technischen Fehlers fehlgeschlagen.