FTP Connector (Advanced)

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

Mögliche Werte:

• List: Liste der Dateien des in Parameter remotePath angegebenen Ordners als XML-Dokument ausgeben

• Send: Daten aus dem vorangegangen Prozess-Schritt in den in Parameter remotePath angegebenen Ordner speichern, dabei den in Parameter documentName festgelegten Dateinamen verwenden. Oder mehrere Dateien von Quellordner in Parameter localPath an remotePath versenden, indem die Parameter directoryMode und multipleFiles auf true gesetzt werden; in Parameter filter kann zudem ein Filterausdruck angegeben werden.

• Receive: Datei in den Prozess einlesen, deren Pfad in Parameter remotePath und deren Dateiname in Parameter documentName festgelegt wurde. Oder mehrere Dateien empfangen, indem die Parameter directoryMode und multipleFiles auf true und localPath auf den lokalen Zielordner gesetzt werden; in Parameter filter kann zudem ein Filterausdruck angegeben werden.

• Delete: In Parameter documentName festgelegte Datei oder Ordner auf dem FTP(S)/SFTP-Server löschen, deren Pfad in Parameter remotePath festgelegt wird. Um nicht-leere Ordner zu löschen, zusätzlich Parameter recurse aktivieren.

• Move: Eine(n) in den Parametern oldPath mit oldDocumentname festgelegte Datei oder festgelegten Ordner innerhalb des FTP(S)/SFTP-Servers nach remotePath  mit documentname verschieben

• Make directory: Ordner auf dem FTP(S)/SFTP-Server erzeugen, dessen Name in Parameter documentName und dessen Pfad in Parameter remotePath festgelegt wird

• Delete directory: Ordner auf dem FTP(S)/SFTP-Server löschen, dessen Name in Parameter documentName und dessen Pfad in Parameter remotePath festgelegt wird

Adapter

Hauptklasse des Adapters (nicht verändern!)

Mögliche Werte: de.softproject.integration.adapter. transferadapter.TransferAdapter: Hauptklasse (Standard)

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)

login

Benutzername für die FTP(S)/SFTP-Verbindung

password

Passwort für die FTP(S)/SFTP-Verbindung; Wenn Parameter privateKeyFile gesetzt ist: Passwort des Private Keys

accountInfo

Zusätzliche Informationen zum Konto, siehe auch Dokumentation der FTP-Bibliothek

loginCommandsUrl

URL zu der im XStore liegenden XML-Datei, welche die Login-Commands enthält

Mögliche Werte: Beliebige XStore-URL

filter

Filterausdruck, der die Platzhalter * und ? enthalten kann, um die Menge der verarbeiteten Dateien einzuschränken. Dies gilt für die Operation list und die Operationen receive und send und nur, wenn die Parameter multipleFiles und directoryMode aktiviert sind.

Mögliche Werte: Beliebige Zeichenkette (z.B. *.xml)

multipleFiles

Alle Dateien verarbeiten, die dem Filterkriterium in Parameter filter entsprechen

Mögliche Werte:

• true: Alle zutreffenden Dateien verarbeiten

• false: Nur die Datei verarbeiten, die in Parameter documentName angegeben wurde, oder wenn Parameter directoryMode aktiviert ist, die erste Datei (falls das Filterkriterium auf mehrere Dateien zutrifft) (Standard)

append

Gesendete Daten an die Zieldatei anhängen, wenn bereits eine gleichnamige Zieldatei besteht (nur bei Operation Send)

Mögliche Werte:

• true: Daten in der Zieldatei (falls vorhanden) anhängen

• false: Zieldatei (falls vorhanden) überschreiben (Standard)

localPath

Lokaler Ordner zum Senden oder Empfangen von mehreren Dateien (nur wenn die Parameter directoryMode und multipleFiles aktiviert sind)

Mögliche Werte: Beliebige gültige Pfadangabe (z.B. C:\Directory)

directoryMode

Ordner-Modus aktivieren, um den Inhalt von Ordnern zu verarbeiten; falls Parameter multipleFiles aktiviert ist, werden alle Elemente verarbeitet, die dem Filterkriterium in Parameter filter entsprechen

Mögliche Werte:

• true: Ordner verarbeiten

• false: Nur einzelne Dateien verarbeiten (Standard)

transferMode

Übertragungsart

Mögliche Werte:

• BINARY: Als Binärdatei übertragen (Standard)

• TEXT: Als Text übertragen

connectMode

Verbindungsmodus

Mögliche Werte:

• ACTIVE: Aktiver Verbindungmodus

• PASSIVE: Passiver Verbindungsmodus (standard)

remotePath

Pfad auf dem FTP(S)/SFTP-Server, dessen Zielordner per FTP(S)/SFTP manipuliert werden soll

Mögliche Werte: Beliebige Zeichenkette (z.B. Folder/Subfolder)

documentname

Name des Ordners oder der Datei, der/die verarbeitet wird. Wenn directoryMode=true gesetzt wurde, wird im Parameter der Ordnername erwartet.

Mögliche Werte: Beliebige Zeichenkette (z.B. Data.xml)

oldDocumentname

Name der Datei, die verschobenen werden soll (nur bei Operation Move)

Mögliche Werte: Beliebige Zeichenkette (z.B. Data.xml)

oldPath

Pfad zum Ordner oder zur Datei auf dem FTP(S)/SFTP-Server, der/die verschoben werden soll (nur bei Operation Move)

Mögliche Werte: Beliebige Zeichenkette (z.B. Folder/Subfolder)

recurse

Pfad rekursiv löschen, d.h. inklusive aller Unterordner und Dateien (nur bei Operation Delete)

Mögliche Werte:

• True: Alle beinhalteten Ordner (und Unterordner) und Dateien löschen

• False: Nur Ordner und Dateien im aktuellen Pfad löschen (Standard)

deleteAfterReceive

Datei oder Ordner nach dem Empfangen vom FTP(S)/SFTP-Server löschen (nur bei Operation Receive)

Mögliche Werte:

• true: Ursprüngliche Datei oder Ordner nach dem Empfangen auf dem FTP(S)/SFTP-Server löschen

• false: Ursprüngliche Datei oder Ordner behalten (Standard)

deleteAfterSend

Datei oder Ordner nach dem Senden zum FTP(S)/SFTP-Server löschen (nur bei Operation Send)

Mögliche Werte:

• true: Ursprüngliche Datei oder Ordner nach dem Senden zum FTP(S)/SFTP-Server löschen

• false: Ursprüngliche Datei oder Ordner behalten (Standard)

maxTransferRate

Maximale Übertragungsrate in Bytes/Sekunde

Mögliche Werte:

• Beliebige positive ganze Zahl

• 0: keine Begrenzung (Standard)

sleepEnabled

Ruhemodus (Sleep Mode) aktivieren (wenn Parameter multipleFiles aktiviert ist)

Mögliche Werte:

• true: Ruhemodus aktivieren (ermöglicht die Definition einer Ruhedauer in Parameter sleepTime)

• false: Ruhemodus deaktivieren (Standard)

sleepTime

Wartezeit in Sekunden zwischen der Übertragung der Dateien (wenn Parameter multipleFiles und sleepEnabled aktiviert sind)

Mögliche Werte:

• Beliebige positive ganze Zahl (Standard)

• 0: Keine Ruhezeit verwenden

timeOut

Zeitbeschränkung für den TCP-Verbindungsaufbau und die Übertragung in Millisekunden

Mögliche Werte:

• Beliebige positive ganze Zahl (z.B. 50000)

• 0: Keine Zeitbeschränkung (Standard)

hostValidationEnabled

Host-Validierung aktivieren, um sicherzustellen, dass der angefragte FTP(S)/SFTP-Server auch dem FTP(S)/SFTP-Server entspricht, mit dem verbunden wird. Idealerweise nur für Testzwecke deaktivieren!

Mögliche Werte:

• true: Host-Validierung aktivieren (Flag setzen)
  (information) Ist die Host-Validierung aktiviert, muss der Parameter hostsFileName gesetzt sein.

• false: Host-Validierung deaktivieren (nicht empfohlen für Produktivsysteme) (Standard)

implicitFTPS

Implicit FTPS aktivieren

Mögliche Werte:

• true: Implicit FTPS aktivieren (Flag setzen)

• false: Implicit FTPS deaktivieren (Standard)

securityMechanism

Sicherheitsmechanismus

Mögliche Werte:

• Explicit_TLS

• Explicit_SSL

• Explicit_TLS_C

• Implicit_PRIVATE

• Implicit_CLEAR

privateKeyFile

Pfad zu einer Private Key-Datei (nicht: Java Keystore). Wenn Sie sich auf dem FTP(S)/SFTP-Server mit einem Private Key authentifizieren möchten, dann dient der Parameter password als Passwort für Ihre Private Key -Datei.

Mögliche Werte: Beliebiger gültiger Pfad (z.B. C:\Data\X4Keys\id_rsa)

hostsFileName

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)

(information) Die Known Hosts-Datei muss wie folgt aufgebaut sein:

host,IP Verschlüsselung Host_PublicKey
ftp.softproject.de,217.160.223.49 ssh-rsa AAAAB3NzaC1yc2EAAAA...

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

useProxy

Proxy-Server für den Verbindungsaufbau verwenden

Mögliche Werte:

• true: Proxy-Server verwenden

• false: Keinen Proxy-Server verwenden (Standard)

proxyType

Proxy-Server-Typ

Mögliche Werte:

• HTTP: HTTP-Proxy verwenden (Standard)

• SOCKS4: Proxy auf Basis des SOCKS 4 -Protokolls verwenden

• SOCKS5: Proxy auf Basis des SOCKS 5 -Protokolls verwenden

proxyAddress

IP-Adresse oder Host-Name des Proxy-Servers

Mögliche Werte: Beliebige gültige Zeichenkette (z.B. server.tld)

proxyPublicAddress

Öffentliche IP-Adresse oder Host-Name des Proxy-Servers, wenn der Proxy keine Adresse zurückgibt (erforderlich z.B. bei aktiven FTP-Übertragungen, wenn der FTP(S)/SFTP-Server sich erneut mit dem Proxy verbinden muss)

Mögliche Werte: Beliebige gültige Zeichenkette (z.B. server.tld)

proxyPort

Port-Nummer des Proxy-Servers

Mögliche Werte: Beliebige positive ganze Zahl

proxyUsername

Benutzername für den Proxy-Server

proxyPassword

Passwort für den Proxy-Server

controlEncoding

Verwendete Kodierung für den Kommando-Kanal. Hiermit wird beeinflusst wie Umlaute in Dateinamen übertragen werden. Dieser Wert ist abhängig vom FTP-Server.

Mögliche Werte: UTF-8 (Standard)

Ist kein controlEncoding gesetzt oder das controlEncoding entspricht dem Leerstring, wird die Verbindung nicht modifiziert und das controlEncoding ist undefiniert. Sonst wird der Wert als controlEncoding auf die Verbindung gesetzt.

1

Die Operation wurde erfolgreich ausgeführt.

-1

Die Operation ist aufgrund eines technischen Fehlers fehlgeschlagen.