Altova RaptorXML+XBRL Server 2025

In diesem Abschnitt:

•Server-Konfigurationsdatei: Anfangseinstellungen

•Server-Konfigurationsdatei: Ändern der Anfangseinstellungen, Zurücksetzen auf die Anfangseinstellungen  

•Server-Konfigurationsdatei: Codefragment und Einstellungen

•Server-Konfigurationsdatei: Beschreibung der Einstellungen  

•Konfigurieren der Server-Adresse

Server-Konfigurationsdatei: Anfangseinstellungen

RaptorXML+XBRL Server wird mit Hilfe einer Konfigurationsdatei namens server_config.xml konfiguriert. Diese Datei befindet sich standardmäßig unter:

C:\Programme (x86)\Altova\RaptorXMLXBRLServer2025\etc\server_config.xml

In der Anfangskonfiguration für RaptorXML+XBRL Server sind die folgenden Einstellungen definiert:

•die Port-Nummer 8087 als Port für den Server.

•dass der Server nur lokale Verbindungen (localhost) empfängt.

•dass der Server die Ausgabedatei in folgenden Ordner schreibt: C:\ProgramData\Altova\RaptorXMLXBRLServer2025\Output\.

Andere Standardeinstellungen sind unter Empfangsbereitschaft von server_config.xml weiter unten beschrieben.

Server-Konfigurationsdatei: Ändern der Anfangseinstellungen, Zurücksetzen auf die Anfangseinstellungen

Wenn Sie die Anfangseinstellungen ändern möchten, müssen Sie die Server-Konfigurationsdatei, server_config.xml (siehe unten) ändern, diese speichern und anschließend RaptorXML+XBRL Server als Dienst neu starten.

Wenn Sie die ursprüngliche Server-Konfigurationsdatei wiederherstellen möchten, (sodass wieder die Anfangseinstellungen für den Server konfiguriert sind), führen Sie den Befehl createconfig aus:

 RaptorXMLXBRLServer.exe createconfig

Bei Ausführung dieses Befehls werden die Anfangseinstellungen wiederhergestellt und die Datei server_config.xml wird damit überschrieben. Der Befehl createconfig :-)ist nützlich, wenn Sie die Server-Konfiguration auf die Anfangseinstellungen zurücksetzen möchten.

Server-Konfigurationsdatei: Codefragment und Einstellungen

Unten sehen Sie den Inhalt der Server-Konfigurationsdatei, server_config.xml, mit den Anfangseinstellungen. Die Einstellungen in dieser Datei sind unterhalb des Codes erläutert.

server_config.xml

<config xmlns="https://www.altova.com/schemas/altova/raptorxml/config"

xsi:schemaLocation="https://www.altova.com/schemas/altova/raptorxml/config
https://www.altova.com/schemas/altova/raptorxml/config.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xs="http://www.w3.org/2001/XMLSchema">

<language>en</language>

<server.unrestricted-filesystem-access>true</server.unrestricted-filesystem-access>

<server.output-root-dir>C:\ProgramData\Altova\RaptorXMLXBRLServer2025\output\</server.output-root-dir>

<server.script-root-dir>C:\Program Files\Altova\RaptorXMLXBRLServer2025\etc\scripts\</server.script-root-dir>

<!--<server.default-script-api-version>2</server.default-script-api-version>-->

<!--<server.catalog-file>catalog.xml</server.catalog-file>-->

<!--<server.log-file>C:\ProgramData\Altova\RaptorXMLXBRLServer2025\Log\server.log</server.log-file>-->

<http.enable>true</http.enable>

<http.environment>production</http.environment>

<http.socket-host>127.0.0.1</http.socket-host>

<http.socket-port>8087</http.socket-port>

<http.log-screen>true</http.log-screen>

<http.access-file>C:\ProgramData\Altova\RaptorXMLXBRLServer2025\Log\access.log</http.access-file>

<http.error-file>C:\ProgramData\Altova\RaptorXMLXBRLServer2025\Log\error.log</http.error-file>

<https.enable>false</https.enable>

<https.socket-host>127.0.0.1</https.socket-host>

<https.socket-port>443</https.socket-port>

<https.private-key>C:\Program Files\Altova\RaptorXMLXBRLServer2025\etc\cert\key.pem</https.private-key>

<https.certificate>C:\Program Files\Altova\RaptorXMLXBRLServer2025\etc\cert\cert.pem</https.certificate>

<!--<https.certificate-chain>/path/to/chain.pem</https.certificate-chain>-->

<syslog.enabled>true</syslog.enabled>

<syslog.protocol>BSD_UDP</syslog.protocol>

<syslog.host>localhost</syslog.host>

<syslog.port>514</syslog.port>

</config>

Einstellungen

Das Einstellen sind in die folgenden Bereiche unterteilt: (i) Allgemeine Einstellungen; (ii) HTTP; (iii) HTTPS; (iv) Syslog.

Allgemeine Server-Einstellungen

language

Definiert die Sprache von Server-Meldungen in einem optionalen language Element. Der Standardwert ist en (Englisch). Zulässige Werte sind en|de|es|fr|ja (Englisch, Deutsch, Spanisch, Französisch, Japanisch). Eine kurze Einführung, wie Sie RaptorXML lokalisieren, finden Sie unter Lokalisierungsbefehle.

server.unrestricted-filesystem-access

•Wenn die Option auf true (den Standardwert) gesetzt ist, werden die Ausgabedateien direkt in den vom Benutzer und in Python-Skripts angegebenen Ordner geschrieben (wobei eventuell Dateien desselben Namens überschrieben werden). Beachten Sie jedoch, dass Dateien bei Zugriff über HTTP über einen entfernten Rechner nicht über lokale Pfade aufgerufen werden können. Wenn RaptorXML+XBRL Server daher auf einem entfernten Rechner ausgeführt wird, setzen Sie den Wert dieser Option auf false. Der Wert sollte nur dann auf true gesetzt werden, wenn Client und Server sich auf demselben Rechner befinden und die Ausgabedateien in ein Verzeichnis auf diesem Rechner geschrieben werden sollen.

•Wenn der Wert auf false gesetzt wird, werden die Dateien im Ausgabeverzeichnis in das Verzeichnis für den Auftrag geschrieben und die URI dieser Dateien wird in das Ergebnisdokument inkludiert. Wenn Sie den Wert auf false setzen, ist die Sicherheitsstufe etwas höher, da die Dateien nur in ein bestimmtes Verzeichnis auf dem Server geschrieben werden können. Die Auftragsausgabedateien können anschließend überprüft und in einen anderen Ordner kopiert werden.

server.output-root-dir

Das Verzeichnis, in dem die Ausgabedateien aller gesendeten Aufträge gespeichert werden.

server.script-root-dir

Das Verzeichnis, in dem vertrauenswürdige Python Skripts gespeichert werden sollen. Die Option script funktioniert bei Verwendung über die HTTP-Schnittstelle nur dann, wenn Skripts aus diesem vertrauenswürdigen Verzeichnis verwendet werden. Wird ein Python Skript aus einem anderen Verzeichnis angegeben, wird ein Fehler zurückgegeben. Siehe 'Python-Skripts sicher machen'.

server.default-script-api-version

Die zum Ausführen von Python Skripts standardmäßig verwendete Python-API-Version. Standardmäßig wird die neueste Version der Python API verwendet. Derzeit werden die Werte 1 und 2 unterstützt. 

server.catalog-file

Die URL der zu verwendenden XML-Katalogdatei. Standardmäßig wird die Katalogdatei RootCatalog.xml aus dem Ordner <ProgramFilesFolder>\Altova\RaptorXMLXBRLServer2025\etc verwendet. Verwenden Sie die server.catalog-file Einstellung nur dann, wenn Sie die Standard-Katalogdatei ändern möchten.

server.log-file

Der Name und Pfad der Server Log-Datei. Die Ereignisse auf dem Server wie z.B. Server gestartet/beendet werden ständig im Ereignis-Log des Systems protokolliert und in einem Ansichtsprogramm für Systemereignisse wie z.B. Windows Event Viewer angezeigt. Zusätzlich zur Anzeige im Ansichtsprogramm können Log-Meldungen auch in die mit der Option server.log-file definierte Datei geschrieben werden. Die Server-Log-Datei enthält Informationen über alle Aktivitäten auf dem Server wie z.B. Fehler beim Server-Start, die verwendeten Konfigurationsdateien und Lizenzfehler.

http

http.enable

Ein Boolescher Wert zum Aktivieren oder Deaktivieren von HTTP: true | false. HTTP kann unabhängig von HTTPS aktiviert/deaktiviert werden. Sowohl HTTP als auch HTTPS können gleichzeitig aktiv sein.

http.environment

Die internen Umgebungen von raptorxml: production| development. Die Development-Umgebung ist mehr auf die Bedürfnisse von Entwicklern ausgerichtet und ermöglicht einfacheres Debuggen als über die Production-Umgebung.

http.socket-host

Die Schnittstelle, über die RaptorXML+XBRL Server aufgerufen wird. Falls RaptorXML+XBRL Server auch Verbindungen mit entfernten Rechnern gestatten soll, kommentieren Sie das Element ein und setzen Sie den Inhalt auf: 0.0.0.0. <http.socket-host>0.0.0.0</http.socket-host>. Dadurch kann der Dienst an jede ansprechbare Schnittstelle des Server-Rechners angebunden werden. Stellen Sie in diesem Fall sicher, dass die Firewall-Einstellungen entsprechend konfiguriert sind. Eingehende Firewall Exceptions für Altova-Produkte müssen folgendermaßen registriert sein: Altova LicenseServer: Port 8088; Altova RaptorXML+XBRL Server: Port 8087; Altova FlowForce Server: Port 8082.

http.socket-port

Der Port, über den der Dienst aufgerufen wird. Der Port muss festgelegt und bekannt sein, damit HTTP Requests korrekt an den Dienst adressiert werden können.

http.log-screen

Wenn RaptorXML+XBRL Server mit dem Befehl RaptorXMLXBRLServer.exe debug, (siehe Starten des Servers) gestartet wird, und wenn http.log-screen auf true gesetzt ist, so wird die Serveraktivität im Eingabeaufforderungsfenster angezeigt. Andernfalls wird die Serveraktivität nicht angezeigt. Zusätzlich zum Schreiben von Log-Dateien, wird der Log-Bildschirm angezeigt.

http.access-file

Der Name und Pfad der HTTP-Zugriffsdatei. Die Zugriffsdatei enthält Informationen über Aktivitäten im Zusammenhang mit dem Zugriff. Sie enthält Informationen, die beim Beheben von Verbindungsproblemen hilfreich sein können.

http.error-file

Der Name und Pfad der HTTP-Fehlerdatei. Die Fehlerdatei enthält Fehler im Zusammenhang mit dem Netzwerkverkehr von und zum Server. Bei Verbindungsproblemen kann diese Datei nützliche Informationen für deren Behebung enthalten.

http.max_request_body_size

Mit dieser Option wird die Maximalgröße des in RaptorXML+XBRL Server zulässigen Request Body in Byte definiert. Der Standardwert ist 100 MB. Wenn die Größe eines Request Body den für diese Option definierten Wert übersteigt, so antwortet der Server mit HTTP Error 413: Request entity too large. Der Wert der Option muss größer oder gleich Null sein. Der Grenzwert kann durch Setzen von http.max_request_body_size=0 deaktiviert werden.

https

https.enable

Ein Boolescher Wert zum Aktivieren oder Deaktivieren von HTTPS: true | false. HTTPS kann unabhängig von HTTP aktiviert/deaktiviert werden. Sowohl HTTP als auch HTTPS können gleichzeitig aktiv sein. HTTPS ist standardmäßig deaktiviert und muss durch Änderung des Werts dieser Einstellung in true aktiviert werden.

https.socket-host

Erhält einen String-Wert, bei dem es sich um die Host-Adresse, unter der HTTPS-Verbindungen gestattet werden, handelt. Um nur Verbindungen vom lokalen Host-Rechner zu gestatten, definieren Sie localhost oder 127.0.0.1. Wenn RaptorXML+XBRL Server Verbindungen von allen entfernten Rechnern zulassen soll, definieren Sie als Wert 0.0.0.0 und zwar in folgender Form: <https.socket-host>0.0.0.0</https.socket-host>. Dadurch kann der Dienst an jede ansprechbare Schnittstelle des Server-Rechners angebunden werden. Stellen Sie in diesem Fall sicher, dass die Firewall-Einstellungen entsprechend konfiguriert sind. Eingehende Firewall Exceptions für Altova-Produkte müssen folgendermaßen registriert sein: Altova LicenseServer: Port 8088; Altova RaptorXML+XBRL Server: Port 8087; Altova FlowForce Server: Port 8082. Auch IPv6-Adressen wie '::' sind zulässig.

https.socket-port

Ein Ganzzahlwert, der den Port, auf dem HTTPS gestattet ist, angibt. Der Port muss festgelegt und bekannt sein, damit HTTP Requests korrekt an den Dienst adressiert werden können.

https.private-key, https.certificate

URIs, die die Pfade zum Private Key bzw. zu den Zertifikatdateien des Servers angeben. Beide URIs sind zwingend erforderlich. Nähere Informationen dazu finden Sie unter HTTPS-Einstellungen und Einrichten der SSL-Verschlüsselung. Auf Windows-Rechnern können auch Windows-Pfade verwendet werden.

https.certificate-chain

Dies ist eine optionale Einstellung, mit der der Pfad zu Zwischenzertifikatdateien angegeben wird. Wenn Sie zwie Zwischenzertifikate (ein primäres und ein sekundäres) haben, so kombinieren Sie diese zu einer Datei, wie in Schritt 7 unter Einrichten der SSL-Verschlüsselung beschrieben. Nähere Informationen dazu finden Sie unter HTTPS-Einstellungen und Einrichten der SSL-Verschlüsselung.

Syslog

syslog.enabled

Ein Boolescher Wert zum Aktivieren oder Deaktivieren des System-Logs: true | false. Der Standardwert ist true. Wenn der Server mit dem Debug-Befehl gestartet wird, wird diese Einstellung ignoriert und die Logs werden in der Konsole angezeigt.

syslog.protocol

Das für das Remote System Logging verwendete Protokoll: BSD_UDP oder BSD_TCP. Die Einstellung wird ignoriert, wenn syslog.host localhost (oder 127.0.0.1 oder ::1) ist.

syslog.host

Der Name oder die IP-Adresse des Logging Host. Die Standardeinstellung ist localhost. Bei der Protokollierung auf localhost wird auf Windows-Systemen der Windows Event Logger verwendet. Für die Protokollierung auf localhost auf anderen Systemen wird Syslog (RFC3164) verwendet.

syslog.port

Ein Ganzzahlwert, der den Port angibt, auf dem der Syslog-Dienst Verbindungen gestattet. Der Port ist normalerweise 514 oder 601 oder 6514. Der Standardwert ist 514. Die Einstellung wird ignoriert, wenn syslog.host localhost (oder 127.0.0.1 oder ::1) ist. Für die Protokollierung auf localhost wird auf Windows-Systemen der Windows Event Logger verwendet. Für die Protokollierung auf localhost auf anderen Systemen wird eine lokale Unix Socket-Verbindung verwendet.