TransdatiX.Comm.FTP
Inhalt
Einführung
Die TransdatiX-Komponente TransdatiX.Comm.FTP ermöglicht den Datenaustausch mit einem FTP-Server per File Transfer Protocol (FTP).
Aufruf der Komponente
Die Schnittstelle stellt sechs Dienste zur Verfügung:
- FTP.Get.ASCII zum Abholen von Text-Daten per FTP
- FTP.Get.Binary zum Abholen binärer Daten per FTP
- FTP.Put.ASCII zum Senden von Text-Daten per FTP
- FTP.Put.Binary zum Senden binärer Daten per FTP
- FTP.Delete zum Löschen einer Datei am FTP-Server
- FTP.Delete zum iterativen Ausführen einer Schnittstelle pro Datei
Folgende Parameter werden von allen Diensten verwendet:
| Parametername (*) | Beschreibung (**) | Hinweise |
| @FTPServer | IP-Adresse des FTP-Servers | IP-Adress oder DNS-Name des Rechners, mit dem Daten ausgetauscht werden sollen. |
| @Port | zu verwendender Port am FTP-Server | Port, über den die Verbindung aufgebaut werden soll. Standardmäßig ist dies bei FTP der Port 21. Daher ist dieser Parameter entsprechend vorbelegt. |
| @Username | Benutzer zur Anmeldung am FTP-Server | Benutzername |
| @Password | Kennwort zur Anmeldung am FTP-Server | Das Kennwort wird bei der Eingabe nicht angezeigt. Wird die Komponente per Kommandozeile aufgerufen so ist das Kennwort jedoch unverschlüsselt anzugeben. |
| @RootDir | Root-Verzeichnis (optional) am FTP-Server | Bei Bedarf kann das Verzeichnis am FTP-Server angegeben werden, das sofort bei der Anmeldung als Startverzeichnis gesetzt werden soll. Die Angabe des Verzeichnisses kann dann realtiv zum Root-Verzeichnis erfolgen. |
| @LocalFileName | Pfad und Dateiname der lokalen Datei | Name inkl. Pfad der Datei am eigenen PC. Beim Senden von Daten ist dies die Ursprungsdatei, beim Abholen die Zieldatei. |
*) Bei Aufruf von Comm.FTP über die Kommandozeile muss zur Parameterübergabe dieser Name verwendet werden.
**) Bei interaktivem Aufruf von Comm.FTP wird im Eingabefenster diese Beschreibung angezeigt.
Die Dienste FTP.Get.ASCII, FTP.GetBinary, FTP.Put.ASCII und FTP.Put.Binary benötigen darüber hinaus noch folgende Parameter:
| Parametername | Beschreibung | Hinweise |
| @RemoteDir | Verzeichnis am entfernten Rechner | Verzeichnis, in dem die abzuholende Datei am entfernten Rechner liegt bzw. in das die zu übertragende Datei gespeichert werden soll. |
| @RemoteFileName | Dateiname am entfernten Rechner | Name der Datei am entfernten Rechner. Beim Senden von Daten ist die Zieldatei, beim Abhlen von Daten die Ursprungsdatei. |
Der Dienst FTP.Delete benötigt folgenden Parameter:
| Parametername | Beschreibung | Hinweise |
| @RemoteFileFullName | Pfad und Dateiname am entfernten Rechner | Name der zu löschenden Datei inkl. Pfadangabe. |
Der Dienst FTP.ProcessFiles benötigt folgende Parameter:
| Parametername | Beschreibung | Hinweise |
| @RemoteFilePattern | Suchmuster für Dateien am FTP-Server | Das Suchmuster für die Dateiliste. Dieses kann auch Pfadangaben enthalten. |
| @ServiceFileName | Schnittstellendatei | Name der Schnittstellendatet (TXF- oder TPF-Datei). |
| @ServiceName | Name des Dienstes | Name des Dienstes, der aufgerufen werden soll. Der Dienstname ist im Fall einer TPF-Datei immer "Main". Dieser Dienst wird für jede Datei, die dem Suchmuster enstspricht, ausgeführt. |
Der Dienst FTP.ProcessFiles ruft vom FTP-Server eine Dateiliste ab und führt für jede Datei den angegebenen Dienst aus. Dabei werden die Informationen über die gerade bearbeitete Datei in Form von Parametern an diesen Dienst übergeben. Dabei werden folgende Parameter befüllt:
| Parametername | Beschreibung |
| @FullName | Dateiname inkl. Pfad. Achtung: wird für die Anmeldung am FTP-Server der Parameter @RootDir verwendet, um das Root-Verzeichnis zu setzen, so ist dieses Verzeichnis trotzdem im Pfad enthalten. |
| @Directory | Pfad ohne Dateiname. Achtung: wird für die Anmeldung am FTP-Server der Parameter @RootDir verwendet, um das Root-Verzeichnis zu setzen, so ist dieses Verzeichnis trotzdem im Pfad enthalten. |
| @Name | Dateiname ohne Pfad |
| @Extension | Dateinamenserweiterung |
| @Length | Dateigröße in Bytes |
| @CreationTime | Erstellungsdatum und -uhrzeit der Datei |