Die Darstellung der Kommandosyntax entspricht der Ausgabe, die Sie beim jeweiligen Kommando durch Angabe des Schalters -h bekommen.
Darstellungsmittel
Bei der Darstellung wird folgende Auszeichnung verwendet:
< > | spitze Klammern kennzeichnen Parameter, die Sie durch jeweils aktuelle |
[ ] | steht für Angaben, die Sie weglassen können. Welche Auswirkungen das |
| | steht für Alternativen. Sie dürfen nur einen der Werte angeben. |
fette Schrift | wird im Abschnitt "Beschreibung" für einzelne Zeichen oder Zeichenketten |
Sonderzeichen und Leerzeichen
Wenn Sie in einem openFT-Kommando Sonderzeichen oder Leerzeichen angeben, müssen Sie Folgendes beachten:
Sonderzeichen müssen besonders behandelt werden, wenn sie auch Steuerzeichen für die jeweilige Kommando-Shell sein können. D.h. sie müssen entweder einzeln entwertet oder eingeschalt werden, damit die Shell sie nicht interpretiert.
Leerzeichen fungieren als Trennzeichen für die Kommando-Optionen und müssen eingeschalt werden, sonst interpretiert openFT alle Zeichen nach dem Leerzeichen als Option.
Zum Entwerten und Einschalten habe Sie folgende Möglichkeiten:
Einzelne Sonderzeichen entwerten Sie mit dem Gegenschrägstrich (\). Ist der Gegenschrägstrich selber das Sonderzeichen, muss er ebenfalls entwertet werden (\\).
Einschalung ist abhängig von der Plattform:
Unix-Systeme: Hochkommas oder Anführungszeichen, z.B.
ft 'partner1!datei 002' 'kennung,,&xyz12'Enthält eine Angabe ebenfalls Hochkommas ('), dann ist es sinnvoll, die gesamte Angabe in Anführungszeichen (") einzuschließen.
Windows-Systeme: Anführungszeichen, z.B.
ftexec ux1 "ftshwl -nb=12" Transunix1Enthält die Angabe ebenfalls Anführungszeichen ("), dann müssen diese mit Gegenschrägstrich (\) entwertet werden.
Sedezimale Eingaben
Zugangsberechtigung, Benutzerkennung, Kennwort und Management Kennwort können sedezimal im Format x’...’ oder X’...’ eingegeben werden.
Auf Unix-Systemen gilt Folgendes:
Bei direkter Eingabe müssen die Hochkommas mit Gegeschrägstrich entwertet werden, z.B. X\'c6d9e4c5\', es sei denn, die komplette Eingabe ist schon eingeschalt.
Bei unsichtbarer Eingabe (z.B. Abfrage des Kennworts am Bildschirm) dürfen die Hochkommas nicht entwertet werden.
Beispiel
Unix-Systeme: x\'f1f2f3f4f5f6f6f8\'.
Windows-Systeme: x'f1f2f3f4f5f6f6f8'.
Reihenfolge der Angaben
Die Anordnung der Angaben im Kommando ist frei.
Ausgenommen davon sind Angaben, die in der Beschreibung der Kommandosyntax nicht mit einem Minuszeichen beginnen, sofern mehr als eine solche Angabe vorliegt wie z.B.:
die Quelle und das Ziel eines Auftrags (z.B. lokaler und ferner Dateiname, Partnername,...)
die Berechtigung für den Zugang zum fernen System, d.h. die Zugangsberechtigung oder das System-Login.
Fortsetzungszeilen in Unix-Systemen
openFT-Kommandos können durch die Vielzahl von Parametern sehr lang werden. Wenn Sie über die Tastatur Kommandos eingeben wollen, die länger als 256 Zeichen sind, müssen Sie mit Fortsetzungszeilen arbeiten. Fortsetzungszeilen erhalten Sie durch die Eingabefolge "\" (Gegenschrägstrich) gefolgt von der Returntaste.
Längenangaben in Windows-Systemen
Kommandos, Folgeverarbeitungskommandos und Dateinamen und werden von openFT in Windows-Systemen im Zeichensatz UTF-8 verwaltet. Die maximale Länge bezieht sich daher jeweils auf die UTF-8-Darstellung. Zeichen, die üblicherweise verwendet werden, aber nicht im Zeichensatz ISO646 (ASCII-Zeichen) enthalten sind, sind in UTF-8 zwei oder drei Bytes lang (z.B. das Euro-Zeichen).
Dateiname
Sie können den Dateinamen absolut oder relativ angeben. Der angegebene Dateiname im lokalen und fernen System darf maximal 512 Zeichen lang sein, wobei die Länge des absoluten Pfadnamens maßgebend ist. Dabei beachten Sie bitte, dass lange Dateinamen zwar an den Schnittstellen von openFT angegeben werden können, jedoch nicht alle Plattformen diese maximale Länge unterstützen. Beispielsweise erlauben Unix-Systeme maximal 512, Windows-Systeme dagegen nur maximal 256 Zeichen.
Enthält der Dateiname Leerzeichen, dann müssen Sie ihn in Anführungszeichen (") einschließen (z.B. "datei name").
Hinweis für Windows-Systeme
Ein lokaler Dateiname darf in UTF-8-Darstellung maximal 512 Bytes lang sein.
Die Angabe von UNC-Namen ist ebenfalls möglich.
Variable %UNIQUE
Endet ein Dateiname mit %unique oder %UNIQUE, so wird diese Zeichenfolge durch einen String ersetzt, der bei jedem erneuten Aufruf wechselt.
Dieser String ist in Unix-Systemen 14 Zeichen, in Windows 18 Zeichen, in BS2000 22 Zeichen und in z/OS 15 bzw.8 Zeichen (bei Bibliotheken) lang.
Ist das Empfangssystem ein Unix- oder Windows-System, dann darf nach %unique oder %UNIQUE noch ein durch einen Punkt getrenntes Suffix angegeben werden, z.B. "datei1%unique.txt". Dieses Suffix darf keinen Punkt mehr enthalten.
Sowohl im Logging als auch bei Meldungen wird nur noch der bereits konvertierte Dateiname angezeigt.
Datum
Das Datum muss numerisch sein, genau 8 Zeichen der Form yyyymmdd mit:yyyy für Jahr, mm für Monat und dd für Tag
Lokale Benutzerkennung
Die maximale Länge der Benutzerkennung ist systemabhängig: In Unix-Systemen maximal 32 Zeichen und in den ersten 8 Zeichen eindeutig, in Windows-Systemen maximal 36 Zeichen. Bei sezedimaler Eingabe darf die Benutzerkennung maximal 64 Zeichen + 3 Zeichen für sedezimale Eingabe (X' ') lang sein, siehe auch Sedezimale Eingaben.
Lokale FTAC-Zugangsberechtigung
Die FTAC-Zugangsberechtigung besteht in der Regel aus abdruckbaren Zeichen und darf nicht mit Bindestrich anfangen, minimal 8 Zeichen. Die maximale Länge ist systemabhängig: in Unix-Systemen maximal 32 und in Windows-Systemen maximal 36 Zeichen. Bei sezedimaler Eingabe darf die FTAC-Zugangsberechtigung maximal 64 Zeichen + 3 Zeichen für sedezimale Eingabe (X' ') lang sein. Besteht eine Zugangsberechtigung aus nicht abdruckbaren Zeichen, dann muss sie sedezimal angegeben werden, siehe Sedezimale Eingaben.
Profilname
Der Profilname muss alphanumerisch sein (a..z, A..Z, 0..9), maximal 8 Zeichen
Eingabe von openFT-Kommandos über Shell-Prozeduren
Wenn openFT-Kommandos über Shell-Prozeduren eingegeben werden, dann ist Folgendes zu beachten:
Unix-Systeme
Auf Unix-Systemen werden in einigen Situatisonen Shell-Prozeduren mit UTF-8-codierten Daten nicht akzeptiert, da sie angeblich binär sind und nicht ausgeführt werden können (cannot execute binary files).
Ungünstigerweise passiert dies vor allem dann, wenn die LANG-Variable beim Aufruf der Prozedur so eingestellt ist, dass sie lokal eine UTF-8-Codierung anzeigt. Auf Linux-Systemen wurde dies zum Beispiel bei der /bin/sh und bei der bash beobachtet, die ksh dagegen kann auch UTF-8-Shellprozeduren ausführen.
Oft hilft es, am Anfang der Shell-Prozedur nochmals die LANG-Variable explizit zu setzen, z.B. export LANG=de_DE.utf8. Wenn die Shell-Prozedur läuft, werden die Kommandos ohne Umcodierung byteweise verarbeitet, so als wären sie nacheinander in einem Konsolfenster eingegeben worden.
Windows-Systeme
Auf Windows-Systemen werden openFT-Kommandoparameter aus einer Shell-Prozedur vom System nach UCS-2 umcodiert. Von welchem Zeichensatz ausgehend dies geschieht, hängt von den Systemeinstellungen ab; im west-/mitteleuropäischen Sprachraum ist üblicherweise der OEM-Zeichensatz CP850 Voreinstellung.
Es ist möglich, den Zeichensatz vor dem Aufruf der Shell-Prozedur, oder auch innerhalb der Prozedur, mit dem Konsolkommando chcp zu variieren. Mit chcp 65001 ist es zum Beispiel möglich, in UTF-8 codierte Prozeduren auszuführen. Diese Prozeduren müssen als Zeilentrenner CRLF verwenden, andere Zeilentrenner (z.B. nur LF) werden von Windows unter Umständen nicht richtig verarbeitet. Für die direkte Eingabe von openFT-
Kommandos in einem Konsolfenster hat die mit chcp eingestellte Codetabelle keine Bedeutung; die Interpretation entspricht der Darstellung im Konsolfenster.
Es empfiehlt sich, in UTF-8 codierte Prozeduren mit dem openFT-Editor zu erstellen und zu bearbeiten (überrftedit -ccs=utf8), da Windows-Editoren meist eine BOM (Byte Order Mask) an den Anfang der Prozedur-Datei schreiben, die beim Aufruf als Bestandteil des ersten Kommandos interpretiert wird.