Extraktionen können über die nachfolgenden Kommandozeilen-Tools ausgeführt werden:
| Kommandozeilen-Tool | Betriebssystem | Verzeichnis |
|---|---|---|
xu.exe |
Windows | Das Kommandozeilen-Tool befindet sich nach der Installation in folgendem Programmverzeichnis (default): C:\Program Files\XtractUniversal\xu.exe. |
xu.elf |
Unix-, Linuxumgebung | Download-Link der Linux-Version des Kommandozeilen-Tools. |
Hinweis: Beide Versionen unterscheiden sich nicht in ihrer Funktionalität und können als eigenständige Programme auf beliebigen Rechnern kopiert und ausgeführt werden.
Achten Sie darauf, dass der Host des Xtract Universal Servers im Netzwerk erreichbar ist.
Extraktion aufrufen #
Das Kommandozeilen-Tool xu.exe verbindet sich zu einem Xtract Universal Server (Service) und startet eine Extraktion mit den folgenden Laufzeitparametern:
| Laufzeit- parameter |
Beschreibung | Syntax |
|---|---|---|
| -h | Eine Kurzdokumentation des Kommandozeilen-Tools | C:\Program Files\XtractUniversal>xu.exe -h |
| -n | Name der Extraktion | C:\Program Files\XtractUniversal\xu.exe -n <name> |
| -s | Der Name oder die IP des Rechners, auf dem der Xtract Universal Service läuft. Der Standardwert ist localhost. Den aktuellen Wert finden Sie im “Run” Fenster des Designers. | xu.exe -n <name> -s <host> |
| -p | Der Port, unter dem der Xtract Universal Service läuft. Der Standardwert ist 8065. Den aktuellen Wert finden Sie im “Run” Fenster des Designers |
xu.exe -n <name> -s <host> -p <port> |
| -o | Parameter, deren Werte beim Ausführen der Extraktion gesetzt werden sollen. Es können mehrere Parameter verwendet werden. |
xu.exe -n <name> -s <host> -p <port> -o "param1=<wert1>" -o "param2=<wert2>" |
| -e | Verwendet Transport Layer Security (TLS) (1.2 oder höher) für die Transportsicherheit. | xu.exe -n <name> -s <host> -p <port> -e |
| -a | Bricht alle aktuell laufenden Instanzen der angegebenen Extraktion ab. | xu.exe -a |
| -c | Löscht den Result-Cache (Ergebnis Cache) für die angegebene Extraktion und deren Optionen. Dies gilt nur für Pull-Destinationen. |
xu.exe -c |
Beispiele
Rufen Sie das Kommandozeilen-Tool in folgender Form auf, um eine Extraktion auf dem Xtract Universal Server zu starten:
xu.exe -n MaterialText
xu.exe -n MaterialText -s 10.0.0.42 -p 80 -o "rows=1000"
xu.exe -n MaterialText -s xusrv.corp.local -p 443 -o "rows=1000" -o "SPRAS=D" -e
xu.exe -n MaterialText -a
xu.exe "http://localhost:8065/?name=MaterialText&rows=1000"
Rückgabewert #
Wenn eine Operation erfolgreich abgeschlossen wurde, gibt das Programm den Wert 0 zurück. Im Falle eines Fehlers, gibt das Programm einen der folgenden Codes zurück:
| HTTP Status-Codes | Beschreibung |
|---|---|
| 404 | Extraktion existiert nicht |
| 1001 | Ein undefinierter Fehler ist aufgetreten |
| 1002 | Die Datei konnte nicht gefunden werden |
| 1013 | Ungültige Eingabedaten |
| 1014 | Die Anzahl der Argumente ist ungültig |
| 1015 | Der Name des Parameters ist unbekannt |
| 1016 | Das Argument ist ungültig |
| 1040 | Timeout-Fehler: Wartezeit auf HTTP-Antwort des Kommandozeilen-Tools überschritten |
| 1053 | Die Extraktions-URL ist falsch |
| 1087 | Der Parameter ist ungültig |
Standardausgabe und Standardfehlerausgabe #
Die Ausgabe ist abhängig vom Destinationstyp der Extraktion. Bei einem erfolgreichen Aufruf wird der Rückgabewert 0 ausgegeben.
Standardausgabe bei Pull-Destinationen
Bei Pull-Destinationen (z.B. HTTP-CSV, HTTP-JSON, etc.) werden die extrahierten Daten im entsprechenden Format (z.B. CSV, JSON, etc.) in die Standardausgabe (stdout) geschrieben.
Standardausgabe bei Push-Destinations
Bei Push-Destinationen wird standardmäßig das Log der Extraktion im CSV-Format in die Standardausgabe (stdout) geschrieben.
Standardfehlerausgabe
Log- und Fehlermeldungen werden in die Standardfehlerausgabe (stderr) geschrieben.
Basic Authentication via Kommandozeile #
Das Kommandozeilen-Tool unterstützt die Ausführung von Extraktionen mit Basic Authentication.
Wenn Sie Extraktionen einplanen, indem Sie das Kommandozeilen-Tool ausführen, können Benutzerdaten für Basic Authentication als Argumente übergeben werden. Während der definierte Xtract Universal Benutzername (Custom User) direkt übergeben werden kann, muss das Custom User Passwort in einer Base 64-Encoding Datei abgelegt sein, auf die das Kommandozeilen-Tool zugreifen kann. Das Dateiformat kann frei gewählt werden, z.B. .txt, .json, .xml, und unterliegt keinen Restriktionen.
- Erstellen Sie eine Passwort-Datei mit dem folgenden Befehl:
xu.exe -f <path to the location and name of the file>, z.B.xu.exe -f "C:\temp\<name of the password file>".
Der Windows-Benutzer muss ausreichende Zugriffsrechte auf den Dateiordner besitzen. Die Passwort-Datei muss nicht im Vorfeld im Windows Explorer erstellt werden.
- Sie werden aufgefordert das korrespondierende Custom User Passwort einzugeben. Es muss mindestens 8 Zeichen lang sein.
- Übergeben Sie den Benutzer und den Pfad der Passwort-Datei als Argumente im Kommandozeilen-Tool, z.B.
xu.exe -s todd.theobald.local -p 8165 -e -n MSEG -u Alice -b "C:\temp\password_custom_user". - OPTIONAL: Achten Sie beim Einplanen der Extraktionen darauf, dass der User-Kontext des Tasks ausreichende Zugriffsrechte auf die erstellte Passwortdatei besitzt.
Note: Für mehr Informationen, verwenden Sie den Befehl xu.exe -h.