X4 Produktdokumentation

SCP

Dieser Adapter sendet und empfängt einzelne Dateien über SCP (Secure CoPy). Der Adapter unterstützt Proxy-Server vom Typ HTTP, SOCKS4 und SOCKS5.

Eigenschaften (Properties)

Operation (action)

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

Mögliche Werte:

  • Send: Eine in Parameter documentname angegebene Datei, die sich in einem in Parameter localPath festgelegten lokalen Ordner befindet, an einen entfernten Ordner versenden, der in Parameter remotePath angeben wurde.

  • Receive: Datei empfangen, deren Pfad in Parameter remotePath und deren Dateiname in Parameter documentName festgelegt wurde und in einem lokalen Ordner speichern, der in Parameter localPath angegeben wurde.

Parameter

host

IP-Adresse oder Host-Name des entfernten Rechners

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

port

Port-Nummer des entfernten Rechners

Mögliche Werte:

  • Beliebige positive ganze Zahl

  • 22: SCP-Standardport (Standard)

login

Benutzername für die SCP-Verbindung

password

Passwort für die SCP-Verbindung; Wenn Parameter privateKeyFile gesetzt ist: Passwort des Private Keys

remotePath

Pfad auf dem entfernten Rechners, mit dem eine Datei ausgetauscht werden soll

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

documentname

Name der Datei, die gesendet oder empfangen werden soll

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

localPath

Lokaler Ordner zum Senden und Empfangen einer Datei

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

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 entfernte Rechner auch dem Rechner entspricht, mit dem verbunden wird. Idealerweise nur für Testzwecke deaktivieren!

Mögliche Werte:

  • Ja: Host-Validierung aktivieren (Flag setzen)

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

privateKeyFile

Pfad zu einer Private Key -Datei (nicht: Java Keystore). Wenn Sie sich auf dem entfernten Rechner 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)

useProxy

Proxy-Server für den Verbindungsaufbau verwenden

Mögliche Werte:

  • Ja: Proxy-Server verwenden

  • Nein: 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

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

Statuswerte

1

Die Operation wurde erfolgreich ausgeführt.

0

Die Operation wurde erfolgreich ausgeführt, jedoch ohne Ergebnis.

-1

Die Operation ist aufgrund eines technischen Fehlers fehlgeschlagen.

Input

Der Adapter erwartet kein bestimmtes Input-Dokument. Ein Input-Dokument wird unverändert wieder ausgegeben.

Output

Ein Input-Dokument wird unverändert wieder ausgegeben.