Abrufen von Fehler-/Meldungs-/Ausgabedokumenten
Ein Ergebnisdokument kann die Datei-URIs oder relativen URIs von Fehlerdokumenten, Meldungsdokumenten (wie z.B. Logs) und/oder Ausgabedokumenten enthalten. (In manchen Fällen enthält das Ergebnisdokument keine URI.) Im Folgenden sind die verschiedenen URI-Arten beschrieben.
Um diese Dokumente über HTTP aufrufen zu können, gehen Sie folgendermaßen vor:
1.Erweitern Sie die relative URI der Datei im Ergebnisdokument zu ihrer absoluten URI.
2.Verwenden Sie die erweiterte URI in einem HTTP GET Request, um die Datei aufzurufen.
URIs von Fehler-/Meldungs-/Ausgabedokumenten (im Ergebnisdokument)
Das Ergebnisdokument enthält URIs von Fehler-, Meldungs- und/oder Ausgabedokumenten. Fehler- und Meldungsdokumente sind Dokumente, die vom Server im Zusammenhang mit einem Auftrag generiert werden; sie werden immer im Auftragsverzeichnis auf dem Server gespeichert. Ausgabedokumente (wie z.B. die Ausgabe von XSLT-Transformationen) können in einem der folgenden Ordner gespeichert werden:
•unter jedem Dateipfad, auf den der Server Zugriff hat. Damit Ausgabedateien in jedem beliebigen Ordner gespeichert werden können, muss der Server für den unbeschränkten Client-Zugriff konfiguriert sein (Standardeinstellung).
•im Auftragsverzeichnis auf dem Server. Der Server ist so konfiguriert, dass er nur eingeschränkten Zugriff von Clients gestattet.
Wenn ein Client verlangt, dass eine Ausgabedatei erstellt wird, hängt der Pfad, unter dem die Ausgabedatei gespeichert wird, von der Option server.unrestricted-filesystem-access der Server-Konfigurationsdatei ab.
•Wenn unbeschränkter Zugriff besteht, wird die Datei in dem vom Client angegebenen Ordner gespeichert. Die für das Dokument zurückgegebene URI ist in diesem Fall eine Datei-URI.
•Wenn der Zugriff eingeschränkt ist, wird die Datei im Auftragsverzeichnis gespeichert. Ihre URI ist dann eine relative URI. Außerdem gibt es ein Mapping dieser relativen URI auf die vom Client angegebene URL. (Siehe Codefragment in Ergebnisdokument, das URIs von Ausgabedokumenten enthält)
Zusammenfassend gibt es die folgenden URI-Arten:
Datei-URI von Fehler-/Meldungsdokumenten
Diese Dokumente werden im Auftragsverzeichnis auf dem Server gespeichert. Datei-URIs haben die folgende Form:
Datei:///<Root-Ausgabe-Verz>/AUFTRAGSID/meldung.doc
Datei-URIs von Ausgabedokumenten
Diese Dokumente können in jedem beliebigen Ordner gespeichert werden. Datei-URIs haben die folgenden Form:
Datei:///<Pfad-zur-Datei>/ausgabe.doc
HTTP-URI von Fehler-/Meldungs-/Ausgabedokumenten
Diese Dokumente werden im Auftragsverzeichnis auf dem Server gespeichert. URIs sind relativ zur Server-Adresse und müssen zur vollständigen HTTP-URI erweitert werden. Die relative URI hat die folgende Form:
/vN/Ergebnisse/AUFTRAGSID/Fehler/Fehler.txt für Fehlerdokumente
/vN/Ergebnisse/AUFTRAGSID/Ausgabe/verbose.log für Meldungsdokumente
/vN/Ergebnisse/AUFTRAGSID/Ausgabe/1 für Ausgabedokumente
Bei Ausgabedokumenten werden Ausgabe-Mappings geliefert (siehe Beispielcode). Damit werden die einzelnen Ausgabedokument-URIs im Ergebnisdokument auf das entsprechende Dokument im Client Request gemappt.
Erweitern der relativen URI
Erweitern Sie die relative URI im Ergebnisdokument zu einer absoluten HTTP-URI, indem Sie der relativen URI die Serveradresse voranstellen. Wenn die Serveradresse z.B. folgendermaßen lautet:
http://localhost:8087/ (die Adresse in der Anfangskonfiguration)
und wenn die relative URI einer Fehlerdatei im Ergebnisdokument folgendermaßen lautet:
/v1/results/20008201-219F-4790-BB59-C091C276FED2/error/error.txt
so ist die erweiterte absolute Adresse:
http://localhost:8087/v1/results/20008201-219F-4790-BB59-C091C276FED2/error/error.txt
Nähere Informationen im Zusammenhang damit finden Sie in den Abschnitten: Konfigurieren des Servers und Abrufen des Ergebnisdokuments.
Verwenden eines HTTP GET Request zum Aufrufen der Datei
Verwenden Sie die erweiterte URI in einem HTTP GET Request, um die gewünschte Datei zu erhalten. RaptorXML+XBRL Server gibt daraufhin das angeforderte Dokument zurück.