Der Xtract Universal Server bietet Zugriff auf verschiedene Metadaten- und Logging-Informationen via Web-Aufrufe.

Basis-URL #

Die Basis-URL für Web-Aufrufe verwendet folgendes Format: [protocol]://[host or IP address]:[port]/.
Achten Sie darauf, das korrekte Protokoll zu verwenden:.

Protokoll Syntax Beispiel
HTTP http://[host].[domain]:[Port] http://todd.theobald.local:8065
HTTP http://[host]:[Port] http://localhost:8065
HTTPS https://[host]:[Port] https://todd.theobald.local:8165
funktioniert ausschließlich mit dedizierten Rechnernamen und X.509 Zertifikat.

Hinweis: Achten Sie auf die korrekten Standardports, siehe Server Ports.

Folgende Aktionen können über Web-Aufrufe ausgeführt werden:

Alle Logs abrufen #

URL Beschreibung
http(s)://[host]:[port]/log/?req_type=all Gibt alle Extraktions-Logs und Server-Logs zurück.

Hinweis: Server-Logs werden nach einer definierten Anzahl von Tagen gelöscht, siehe Server Einstellungen - Web Server.

Antwort

Der Web-Aufruf gibt folgende Informationen zurück:

  • LineCount: Zeilennummer des Log-Eintrags.
  • Name: Name der Extraction / Name des Servers.
  • Timestamp: Zeitstempel der Extraktion oder des Server-Logs.
  • State: Gibt eine Zahl zwischen 2 und 4 für eine Extraktion oder die Zahl 5 für einen Server-Log zurück.
  • StateDescr: Beschreibung des Status’, siehe untenstehende Tabelle.
  • LogLevel: Art des Logs (“Error”, “Info” “Warning” oder “Debug”).
  • Source technischer Name der Komponente, die die Informationen des Logs generiert.
  • Message: Inhalt des Logs.
State StateDescr Beschreibung
2 Running Die Extraktion läuft gerade.
3 FinishedNoErrors Die Extraktion ist erfolgreich gelaufen.
4 FinishedErrors Die Extraktion ist abgeschlossen, aber mindestens ein Fehler ist aufgetreten.
5 NotAvailable Der Status bei einem Server-Log.

Für Informationen, wie man Extraction-Logs interpretiert, siehe Extraktions-Logs Lesen.

Beispiel

Beispiel-URLBeispiel-Antwort
https://todd.theobald.local:8165/log/?req_type=all 
LineCount,Name,Timestamp,State,StateDescr,LogLevel,Source,Message
1,MAKT,2023-02-20_09:49:23.941,3,FinishedNoErrors,Info,LiveDataExtraction,Product version 5.21.10.14
2,MAKT,2023-02-20_09:49:23.942,3,FinishedNoErrors,Info,LiveDataExtraction,Using Theobald.Extractors Interface
3,MAKT,2023-02-20_09:49:23.999,3,FinishedNoErrors,Info,LiveDataExtraction,Theobald.Extractors version 1.39.3.13
4,MAKT,2023-02-20_09:49:23.999,3,FinishedNoErrors,Info,LiveDataExtraction,Executing Table extraction
...
1,[server],2023-02-20_09:49:10.208,5,NotAvailable,Warning,VersionStore,Configuration was created by a development build. This can lead to unexpected behaviour.
2,[server],2023-02-20_09:49:10.258,5,NotAvailable,Info,AsyncTcpServer,Trying to listen on [::]:8065...
3,[server],2023-02-20_09:49:10.258,5,NotAvailable,Info,AsyncTcpServer,Listening on [::]:8065
4,[server],2023-02-20_09:49:23.353,5,NotAvailable,Info,AsyncTcpServer,Client [::1]:51531 connected
...

Logs zu einem bestimmten Zeitstempel abrufen #

URL Beschreibung
http(s)://[host]:[port]/log/?req_type=all&timestamp=[yyyy-MM-dd] Gibt alle Logs an dem definierten Datum zurück.
http(s)://[host]:[port]/log/?req_type=all&timestamp=[yyyy-MM-dd_HH:mm:ss.SSS] Gibt alle Logs an dem definierten Zeitstempel zurück.
http(s)://[host]:[port]/log/?req_type=all&min=[yyyy-MM-dd] Gibt alle Logs nach dem definierten Datum zurück.
http(s)://[host]:[port]/log/?req_type=all&min=[yyyy-MM-dd_HH:mm:ss.SSS] Gibt alle Logs nach dem definierten Zeitstempel zurück.
http(s)://[host]:[port]/log/?req_type=all&max=[yyyy-MM-dd] Gibt alle Logs vor dem definierten Datum zurück.
http(s)://[host]:[port]/log/?req_type=all&max=[yyyy-MM-dd_HH:mm:ss.SSS] Gibt alle Logs vor dem definierten Zeitstempel zurück.
http(s)://[host]:[port]/log/?req_type=all&min=[yyyy-MM-dd]&max=[yyyy-MM-dd] Gibt alle Logs zwischen den definierten Tagen zurück.
http(s)://[host]:[port]/log/?req_type=all&min=[yyyy-MM-dd_HH:mm:ss.SSS]&max=[yyyy-MM-dd_HH:mm:ss.SSS] Gibt alle Logs zwischen den definierten Zeitstempeln zurück.
http(s)://[host]:[port]/log/?req_type=all&past_days=[number_of_days] Gibt alle Logs seit n Tagen zurück.

Antwort

Der Web-Aufruf gibt folgende Informationen zurück:

  • LineCount: Zeilennummer des Log-Eintrags.
  • Name: Name der Extraction / Name des Servers.
  • Timestamp: Zeitstempel der Extraktion oder des Server-Logs.
  • State: Gibt eine Zahl zwischen 2 und 4 für eine Extraktion oder die Zahl 5 für einen Server-Log zurück.
  • StateDescr: Beschreibung des Status’, siehe untenstehende Tabelle.
  • LogLevel: Art des Logs (“Error”, “Info” “Warning” oder “Debug”).
  • Source technischer Name der Komponente, die die Informationen des Logs generiert.
  • Message: Inhalt des Logs.
State StateDescr Beschreibung
2 Running Die Extraktion läuft gerade.
3 FinishedNoErrors Die Extraktion ist erfolgreich gelaufen.
4 FinishedErrors Die Extraktion ist abgeschlossen, aber mindestens ein Fehler ist aufgetreten.
5 NotAvailable Der Status bei einem Server-Log.

Für Informationen, wie man Extraction-Logs interpretiert, siehe Extraktions-Logs Lesen.

Beispiel

Beispiel-URLBeispiel-Antwort
https://todd.theobald.local:8165/log/?req_type=all&past_days=2 
LineCount,Name,Timestamp,State,StateDescr,LogLevel,Source,Message
1,MAKT,2023-02-20_09:49:23.941,3,FinishedNoErrors,Info,LiveDataExtraction,Product version 5.21.10.14
2,MAKT,2023-02-20_09:49:23.942,3,FinishedNoErrors,Info,LiveDataExtraction,Using Theobald.Extractors Interface
3,MAKT,2023-02-20_09:49:23.999,3,FinishedNoErrors,Info,LiveDataExtraction,Theobald.Extractors version 1.39.3.13
4,MAKT,2023-02-20_09:49:23.999,3,FinishedNoErrors,Info,LiveDataExtraction,Executing Table extraction
...
1,[server],2023-02-20_09:49:10.208,5,NotAvailable,Warning,VersionStore,Configuration was created by a development build. This can lead to unexpected behaviour.
2,[server],2023-02-20_09:49:10.258,5,NotAvailable,Info,AsyncTcpServer,Trying to listen on [::]:8065...
3,[server],2023-02-20_09:49:10.258,5,NotAvailable,Info,AsyncTcpServer,Listening on [::]:8065
4,[server],2023-02-20_09:49:23.353,5,NotAvailable,Info,AsyncTcpServer,Client [::1]:51531 connected
...
https://todd.theobald.local:8165/log/?req_type=all&min=2023-02-20_09:49:24.500&max=2023-02-20_09:50:00.000 
LineCount,Name,Timestamp,State,StateDescr,LogLevel,Source,Message
22,MAKT,2023-02-20_09:49:24.500,3,FinishedNoErrors,Debug,TheoReadTableExtractor,Data will be extracted in dialog work process
23,MAKT,2023-02-20_09:49:24.501,3,FinishedNoErrors,Debug,TheoReadTableExtractor,"Fetching packages (50,000 rows per package)"
24,MAKT,2023-02-20_09:49:24.653,3,FinishedNoErrors,Debug,TheoReadTableExtractor,Z_THEO_READ_TABLE version 1.x
25,MAKT,2023-02-20_09:49:24.653,3,FinishedNoErrors,Debug,TheoReadTableExtractor,Received package #1 (1 rows)
26,MAKT,2023-02-20_09:49:24.657,3,FinishedNoErrors,Info,LiveDataExtraction,Starting to write 1 rows to destination...
27,MAKT,2023-02-20_09:49:24.668,3,FinishedNoErrors,Info,LiveDataExtraction,Finished writing rows to destination
28,MAKT,2023-02-20_09:49:24.712,3,FinishedNoErrors,Info,TheoReadTableExtractor,Extraction finished - received 1 rows in total
29,MAKT,2023-02-20_09:49:24.714,3,FinishedNoErrors,Debug,LiveDataExtraction,Writing results to destination completed
6,[server],2023-02-20_09:49:24.802,5,NotAvailable,Debug,ProcessAsync,Theobald.Xu.Web.Worker.exe (16240) exited with 0x0 - The operation completed successfully
7,[server],2023-02-20_09:49:36.257,5,NotAvailable,Info,AsyncTcpServer,Client [::1]:51533 connected
8,[server],2023-02-20_09:49:36.262,5,NotAvailable,Debug,ProcessAsync,Theobald.Xu.Web.Worker.exe (16368) started

Alle Server-Logs Abrufen #

URL Beschreibung
http(s)://[host]:[port]/log/?req_type=server Gibt eine Liste von Zeitstempeln zurück, die zu Server-Logs gehören.

Antwort

Der Web-Aufruf gibt Zeitstemepl im Format [yyyy-MM-dd_HH:mm:ss.SSS] zurück.
Verwenden Sie die Zeitstempel, um den Inhalt von Logs abzurufen, siehe Server-Logs zu einem bestimmten Zeitstempel abrufen.

Hinweis: Server-Logs werden nach einer definierten Anzahl von Tagen gelöscht, siehe Server Einstellungen - Web Server.

Beispiel

Beispiel-URLBeispiel-Antwort
https://todd.theobald.local:8165/log/?req_type=server 
Timestamp
2023-02-20_09:49:10.055
2023-02-15_13:49:38.401

Server-Logs zu einem bestimmten Zeitstempel abrufen #

URL Beschreibung
http(s)://[host]:[port]/log/?req_type=server&timestamp=[yyyy-MM-dd_HH:mm:ss.SSS] Gibt die Server-Logs von einem definierten Zeitstempel zurück.

Tipp: Rufen Sie zurvor die Zeitstempel ab, die zu Server-Logs gehören, siehe Alle Server-Logs abrufen.
Um Server-Logs abzurufen, die vor, nach oder zwischen Zeitstempeln liegen, siehe Logs zu einem bestimmten Zeitstempel abrufen.

Hinweis: Server-Logs werden nach einer definierten Anzahl von Tagen gelöscht, siehe Server Einstellungen - Web Server.

Antwort

Der Web-Aufruf gibt folgende Informationen zurück:

  • LineCount: Zeilennummer des Log-Eintrags.
  • Name: Name der Extraction / Name des Servers.
  • Timestamp: Zeitstempel des Server-Logs.
  • State: Gibt die Zahl 5 für einen Server-Log zurück.
  • StateDescr: Beschreibung des Status’.
  • LogLevel: Art des Logs (“Error”, “Info” “Warning” oder “Debug”).
  • Source technischer Name der Komponente, die die Informationen des Logs generiert.
  • Message: Inhalt des Logs.

Beispiel

Beispiel-URLBeispiel-Antwort
https://todd.theobald.local:8165/?req_type=server&timestamp=2023-02-20_09:49:10.228 
LineCount,Name,Timestamp,State,StateDescr,LogLevel,Source,Message 
1,[server],2023-02-20_09:49:10.258,5,NotAvailable,Info,AsyncTcpServer,Trying to listen on [::]:8065... 
2,[server],2023-02-20_09:49:10.258,5,NotAvailable,Info,AsyncTcpServer,Listening on [::]:8065 
3,[server],2023-02-20_09:49:23.353,5,NotAvailable,Info,AsyncTcpServer,Client [::1]:51531 connected 
4,[server],2023-02-20_09:49:23.372,5,NotAvailable,Debug,ProcessAsync,Theobald.Xu.Web.Worker.exe (16240) started 
5,[server],2023-02-20_09:49:24.802,5,NotAvailable,Debug,ProcessAsync,Theobald.Xu.Web.Worker.exe (16240) exited with 0x0 - The operation completed successfully 
6,[server],2023-02-20_09:49:36.257,5,NotAvailable,Info,AsyncTcpServer,Client [::1]:51533 connected 
7,[server],2023-02-20_09:49:36.262,5,NotAvailable,Debug,ProcessAsync,Theobald.Xu.Web.Worker.exe (16368) started

Eine Liste aller definierten Extraktionen abrufen #

URL Beschreibung
http(s)://[host]:[port]/extractions Gibt eine Liste aller definierten Extraktionen zurück.
http(s)://[host]:[port]/config/extractions/ Gibt eine Liste aller definierten Extraktionen im JSON-Format zurück.

Antwort

Der Web-Aufruf gibt folgende Informationen zurück:

  • Name: Name der Extraktion.
  • Type: Extraktionstyp, z.B. Table, Report, ODP, etc.
  • Source: Name der SAP-Verbindung.
  • Destination: Name der Destination.
  • LastRun: Zeitstempel der letzten Ausführung.
  • RowCount: Anzahl der zuletzt extrahierten Datensätze.
  • LastChange: Zeitstempel der letzten Änderung.
  • Created: Zeitstempel der Erstellung.

Beispiel

Beispiel-URLBeispiel-Antwort
https://todd.theobald.local:8165/extractions 
Name,Type,Source,Destination,LastRun,RowCount,LastChange,Created
MAKT,Table,ec5,csv,2022-12-15_13:30:08.921,177318,2023-02-15_13:49:38.401,2022-12-12_08:39:27.407
2LIS,ODP,ec5,AzureStorageAD,2022-08-18_10:55:00.189,59058,2023-01-20_11:26:05.641,2022-08-18_10:46:50.721
COUNTRY,Hierarchy,bw2,http-csv,2022-12-01_12:53:57.098,8,2022-12-01_12:53:53.599,2022-10-05_10:41:43.848
RLT10010,Report,ec5,csv,2023-01-12_11:11:48.975,21,2022-12-13_11:07:36.437,2022-06-30_08:24:47.755
https://todd.theobald.local:8165/config/extractions/ 
{
    "extractions": 
    [
        {
            "name": "MAKT",
            "type": "Table",
            "source": "ec5",
            "destination": "csv",
            "latestRun": {
                "started": "20221215T133008.921Z",
                "duration": "PT00H00M02.850S",
                "rowsCount": 177318,
                "state": "FinishedNoErrors"
            },
            "lastChange": {
                "machine": "SHERRI",
                "user": "alice",
                "timestamp": "20230215T134938.401Z"
            },
            "created": {
                "machine": "SHERRI",
                "user": "alice",
                "timestamp": "20221212T083927.407Z"
            }
        }
    ]
}

Eine bestimmte Extraktion zu einem bestimmten Zeitstempel abrufen #

URL Beschreibung
http(s)://[host]:[port]/log/?req_type=extraction&name=[extraction_name]&timestamp=[yyyy-MM-dd_HH:mm:ss.SSS] Gibt detailierte Logs der definierten Extraktion an dem definierten Zeitstempel zurück.

Tipp: Rufen Sie den Zeitstempel ab, an dem die Extraktion das letzte Mal ausgeführt wurde, siehe Eine Liste aller definierten Extraktionen abrufen oder rufen Sie Zeitstempel ab über Alle Logs abrufen.

Antwort

Der Web-Aufruf gibt folgende Informationen zurück:

  • LineCount: Zeilennummer des Log-Eintrags.
  • Name: Name der Extraction.
  • Timestamp: Zeitstempel der Extraktion.
  • State: Gibt eine Zahl zwischen 2 und 4 für eine Extraktion zurück.
  • StateDescr: Beschreibung des Status’, siehe untenstehende Tabelle.
  • LogLevel: Art des Logs (“Error”, “Info” “Warning” oder “Debug”).
  • Source technischer Name der Komponente, die die Informationen des Logs generiert.
  • Message: Inhalt des Logs.
State StateDescr Beschreibung
2 Running Die Extraktion läuft gerade.
3 FinishedNoErrors Die Extraktion ist erfolgreich gelaufen.
4 FinishedErrors Die Extraktion ist abgeschlossen, aber mindestens ein Fehler ist aufgetreten.

Für Informationen, wie man Extraction-Logs interpretiert, siehe Extraktions-Logs Lesen.

Beispiel

Beispiel-URLBeispiel-Antwort
https://todd.theobald.local:8165/log/?req_type=extraction&name=makt&timestamp=2023-02-20_09:49:23.807 
LineCount,Name,Timestamp,State,StateDescr,LogLevel,Source,Message
1,makt,2023-02-21_11:04:33.765,3,FinishedNoErrors,Info,LiveDataExtraction,Product version 5.21.10.14
2,makt,2023-02-21_11:04:33.766,3,FinishedNoErrors,Info,LiveDataExtraction,Using Theobald.Extractors Interface
3,makt,2023-02-21_11:04:33.817,3,FinishedNoErrors,Info,LiveDataExtraction,Theobald.Extractors version 1.39.3.13
4,makt,2023-02-21_11:04:33.817,3,FinishedNoErrors,Info,LiveDataExtraction,Executing Table extraction
5,makt,2023-02-21_11:04:33.882,3,FinishedNoErrors,Info,LiveDataExtraction,Found license.
6,makt,2023-02-21_11:04:33.930,3,FinishedNoErrors,Debug,R3ConnectorServerWindows,'Use SAPGUI' expert option is disabled
7,makt,2023-02-21_11:04:33.931,3,FinishedNoErrors,Debug,R3ConnectorServerWindows,"Connecting to SAP application server, using Classic RFC SDK"
8,makt,2023-02-21_11:04:33.931,3,FinishedNoErrors,Debug,R3ConnectorServerWindows,"Client '800',  language 'EN'"
9,makt,2023-02-21_11:04:33.931,3,FinishedNoErrors,Debug,R3ConnectorServerWindows,"User ALICE, Password has been provided"
10,makt,2023-02-21_11:04:33.931,3,FinishedNoErrors,Debug,R3ConnectorServerWindows,Using plain authentication
11,makt,2023-02-21_11:04:34.291,3,FinishedNoErrors,Info,R3ConnectorServerWindows,"Connected to SAP host 'sap-erp-as05.example.com', instance 00, release 740, codepage 4103, user 'ALICE'"
...

Den Status einer Extraktion abrufen #

URL Beschreibung
http(s)://[host]:[port]/status/?name=[extraction_name]&timestamp=[yyyy-MM-dd_HH:mm:ss.SSS] Gibt den Status einer definierten Extraktion an einem definierten Zeitstempel zurück.

Führen Sie die folgenden Schritte aus, um eine Routine für einen Status-Check zu erstellen:

  1. Führen Sie Ihre Extraktion im asynchronen modus aus, indem Sie folgendes URl-Schema verwenden:
    http(s)://[host]:[port]/?name=[extraction_name]&wait=false
    Der asynchrone Aufruf erzeugt sofort eine HTTP-Antwort, noch während die Extraktion ausgeführt wird. Für mehr Informationen zum Ausführen von Extraktionen, siehe Extraktionen Ausführen und Einplanen - Aufruf via Webservice.
  2. Kopieren Sie den Zeitstempel, der in der HTTP-Antwort des asynchronen Extraktionsaufrufs zurpckgegeben wird.
    Beispiel: X-XU-Timestamp: 2023-01-28_09:58:47.312.
  3. Verwenden Sie den Extraktionsnamen und den Zeitstempel, um den Status der Extraktion mit folgendem URL-Schema abzurufen:
    http(s)://[host]:[port]/status/?name=[extraction_name]&timestamp=[yyyy-MM-dd_HH:mm:ss.SSS]
  4. Der Status einer Extraktion ändert sich mit der Zeit. Fragen Sie den Status der Extraktion in einer Schleife ab, um Folgemaßnahmen zu ergreifen, sobald die Extraktion beendet ist.

Hinweis: Eine Extraktion im asynchronen Modus auszuführen und den Extraktionsstatus abzurufen, wird nur bei Push-Destinationen unterstützt, z.B. Datenbanken.

Antwort

Der Web-Aufruf gibt folgende Informationen zurück:

Status Beschreibung
Running Die Extraktion läuft gerade.
FinishedNoErrors Die Extraktion ist erfolgreich gelaufen.
FinishedErrors Die Extraktion ist abgeschlossen, aber mindestens ein Fehler ist aufgetreten.

Beispiel

Beispiel-URLBeispiel-Antwort
https://todd.theobald.local:8165/status/?name=makt&timestamp=2023-02-21_11:06:16.314 
FinishedNoErrors
https://todd.theobald.local:8165/status/?name=mara&timestamp=2023-02-21_13:11:27.327 
FinishedErrors