Configurer le serveur
Cette section :
•Fichier de configuration du serveur : paramètres initiaux
•Fichier de configuration du serveur : liste et paramètres
•Fichier de configuration du serveur : description des paramètres
•Configurer l'adresse du serveur
Fichier de configuration du serveur : paramètres initiaux
RaptorXML+XBRL Server est configuré à l'aide d'un fichier de configuration appelé server_config.xml, qui se trouve par défaut à l'emplacement suivant :
C:\Program Files (x86)\Altova\RaptorXMLXBRLServer2026\etc\server_config.xml
La configuration initiale pour RaptorXML+XBRL Server définit ce qui suit :
•Le numéro de port 8087 comme port du serveur.
•Le serveur n'écoute que les connexions locales (localhost).
•Le serveur enregistre les données de sortie dans C:\ProgramData\Altova\RaptorXMLXBRLServer2026\Output\.
Les autres paramètres par défaut sont affichés dans la liste du fichier server_config.xml ci-dessous.
Fichier de configuration du serveur : modification des paramètres initiaux, restauration des paramètres initiaux
Si vous souhaitez modifier les paramètres initiaux, il est nécessaire de modifier le fichier de configuration du serveur, server_config.xml (voir liste ci-dessous), de l'enregistrer, puis de redémarrer RaptorXML+XBRL Server en tant que service.
Si vous souhaitez recréer le fichier de configuration d'origine du serveur (afin que le serveur soit à nouveau configuré avec les paramètres initiaux), exécutez la commande createconfig :
RaptorXMLXBRLServer.exe createconfig
Lorsque vous exécutez cette commande, le fichier de paramètres initiaux sera recréé et remplacera le fichier server_config.xml. La commande createconfig est utile si vous souhaitez réinitialiser la configuration du serveur aux paramètres initiaux.
Fichier de configuration du serveur : liste et paramètres
Le fichier de configuration du serveur, server_config.xml, est présenté ci-dessous avec ses paramètres initiaux. Les paramètres disponibles sont expliqués ci-dessous.
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\RaptorXMLXBRLServer2026\output\</server.output-root-dir>
<server.script-root-dir>C:\Program Files\Altova\RaptorXMLXBRLServer2026\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\RaptorXMLXBRLServer2026\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\RaptorXMLXBRLServer2026\Log\access.log</http.access-file>
<http.error-file>C:\ProgramData\Altova\RaptorXMLXBRLServer2026\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\RaptorXMLXBRLServer2026\etc\cert\key.pem</https.private-key>
<https.certificate>C:\Program Files\Altova\RaptorXMLXBRLServer2026\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>
Réglages
Les paramètres sont répartis dans les catégories suivantes : (i) Paramètres généraux du serveur ; (ii) HTTP ; (iii) HTTPS ; (iv) Syslog.
Paramètres généraux du serveur
language
Définit la langue des messages du serveur, dans un élément language facultatif. La valeur par défaut est en (anglais). Les valeurs autorisées sont en|de|es|fr|ja (anglais, allemand, espagnol, français et japonais, respectivement). Voir Commandes de localisation pour obtenir un aperçu de la manière de localiser RaptorXML.
server.unrestricted-filesystem-access
•Lorsque cette option est définie sur true (valeur par défaut), les fichiers de sortie seront enregistrés directement à l'emplacement spécifié par l'utilisateur et dans les scripts Python (remplaçant éventuellement des fichiers existants du même nom). Notez toutefois que les chemins d'accès aux fichiers locaux ne peuvent pas être utilisés pour accéder à des fichiers à partir d'un ordinateur distant via HTTP. Par conséquent, si RaptorXML+XBRL Server est utilisé sur une machine distante, définissez la valeur de cette option sur false. Définir la valeur sur true n'est envisageable que si le client et le serveur se trouvent sur la même machine et que vous souhaitez écrire les fichiers de sortie dans un répertoire de cette machine.
•Lorsque la valeur est définie sur false, les fichiers sont écrits dans le répertoire de tâches dans le répertoire de sortie, et les URI de ces fichiers sont inclus dans le document de résultat. La valeur false offre une couche de sécurité supplémentaire, car les fichiers ne peuvent être écrits sur le disque que dans un répertoire de tâches dédié et connu sur le serveur. Les fichiers de sortie des tâches peuvent ensuite être copiés de manière sécurisée vers d'autres emplacements.
server.output-root-dir
Répertoire dans lequel la sortie de toutes les tâches soumises est enregistrée.
server.script-root-dir
Répertoire dans lequel les scripts Python approuvés doivent être enregistrés. L'option script, lorsqu'elle est utilisée via l'API HTTP, ne fonctionnera que si les scripts proviennent de ce répertoire approuvé. La spécification d'un script Python provenant d'un autre répertoire entraînera une erreur. Voir Sécurisation des scripts Python.
server.default-script-api-version
Version par défaut de l'API Python utilisée pour exécuter les scripts Python. Par défaut, la dernière version de l'API Python est utilisée. Les valeurs actuellement prises en charge sont 1 et 2.
server.catalog-file
URL du fichier catalogue XML à utiliser. Par défaut, le fichier catalogue RootCatalog.xml, qui se trouve dans le dossier <ProgramFilesFolder>\Altova\RaptorXMLXBRLServer2026\etc, sera utilisé. Utilisez le paramètre server.catalog-file uniquement si vous souhaitez modifier le fichier catalogue
server.log-file
Nom et emplacement du fichier journal du serveur. Les événements sur le serveur, tels que Serveur démarré/arrêté, sont consignés en continu dans le journal des événements du système et affichés dans un visualiseur d'événements système tel que Windows Event Viewer. En plus de l'affichage dans le visualiseur, les messages du journal peuvent également être enregistrés dans le fichier spécifié avec l'option server.log-file. Le fichier journal du serveur contient des informations sur toutes les activités du serveur, y compris les erreurs de démarrage du serveur, le fichier de configuration utilisé et les erreurs de licence.
http
http.enable
Valeur booléenne pour activer ou désactiver HTTP : true | false. HTTP peut être activé/désactivé indépendamment de HTTPS, et les deux peuvent être actifs simultanément.
http.environment
Environnements internes de raptorxml : production | développement. L'environnement de développement sera davantage adapté aux besoins des développeurs, permettant un débogage plus facile que lorsque l'environnement de production est utilisé.
http.socket-host
Interface via laquelle RaptorXML+XBRL Server est accessible. Si vous souhaitez que RaptorXML+XBRL Server accepte les connexions provenant de machines distantes, décommentez l'élément et définissez son contenu sur : 0.0.0.0, comme ceci : <http.socket-host>0.0.0.0</http.socket-host>. Cela héberge le service sur toutes les interfaces adressables de la machine serveur. Dans ce cas, assurez-vous que les paramètres du pare-feu sont correctement configurés. Les exceptions de pare-feu entrant pour les produits Altova doivent être enregistrées comme suit : Altova LicenseServer: port 8088; Altova RaptorXML+XBRL Server: port 8087; Altova FlowForce Server: port 8082.
http.socket-port
Port à partir duquel le service est accessible. Le port doit être fixe et connu afin que les requêtes HTTP puissent être correctement adressées au service.
http.log-screen
Si RaptorXML+XBRL Server est démarré avec la commande RaptorXMLXBRLServer.exe debug (voir Démarrage du serveur) et si http.log-screen est défini sur true, l'activité du serveur s'affiche dans la console de ligne de commande. Sinon, l'activité du serveur ne s'affiche pas. L'écran de journalisation s'affiche en plus de l'écriture des fichiers journaux.
http.access-file
Nom et emplacement du fichier d'accès HTTP. Le fichier d'accès contient des informations sur l'activité liée à l'accès. Il contient des informations utiles pour résoudre les problèmes de connexion.
http.error-file
Nom et emplacement du fichier d'erreurs HTTP. Le fichier d'erreurs contient les erreurs liées au trafic vers et depuis le serveur. En cas de problèmes de connexion, ce fichier peut fournir des informations utiles pour les résoudre.
http.max_request_body_size
Cette option spécifie la taille maximale, en octets, du corps de la requête accepté par RaptorXML+XBRL Server. La valeur par défaut est 100 Mo. Si la taille du corps de la requête est supérieure à la valeur spécifiée pour cette option, le serveur répond avec HTTP Error 413: Request entity too large. La valeur de l'option doit être supérieure ou égale à zéro. La limite peut être désactivée en définissant http.max_request_body_size=0.
https
https.enable
Valeur booléenne pour activer ou désactiver HTTPS : true | false. HTTPS peut être activé/désactivé indépendamment de HTTP, et les deux peuvent être actifs simultanément. La prise en charge HTTPS est désactivée par défaut et doit être activée en définissant la valeur de ce paramètre sur true.
https.socket-host
Accepte une valeur de chaîne qui correspond à l'adresse hôte sur laquelle les connexions HTTPS sont acceptées. Pour accepter uniquement les connexions provenant de l'hôte local, définissez localhost ou 127.0.0.1. Si vous souhaitez que RaptorXML+XBRL Server accepte les connexions provenant de toutes les machines distantes, définissez la valeur sur : 0.0.0.0, comme ceci : <https.socket-host>0.0.0.0</https.socket-host>. Cela héberge le service sur toutes les interfaces adressables de la machine serveur. Dans ce cas, assurez-vous que les paramètres du pare-feu sont correctement configurés. Les exceptions de pare-feu entrant pour les produits Altova doivent être enregistrées comme suit : Altova LicenseServer: port 8088; Altova RaptorXML+XBRL Server: port 8087; Altova FlowForce Server: port 8082. Vous pouvez également utiliser des adresses IPv6 telles que : '::'.
https.socket-port
Valeur entière correspondant au port sur lequel HTTPS est accepté. Le port doit être fixe et connu afin que les requêtes HTTP puissent être correctement adressées au service.
https.private-key, https.certificate
URI correspondant respectivement aux chemins d'accès aux fichiers de clé privée et de certificat du serveur. Les deux sont requis. Pour plus d'informations, voir Paramètres HTTPS et Configurer le cryptage SSL. Sur les machines Windows, vous pouvez également utiliser les chemins d'accès Windows.
https.certificate-chain
Paramètre facultatif, il s'agit d'un URI qui localise le fichier de certificat intermédiaire. Si vous disposez de deux certificats intermédiaires (principal et secondaire), combinez-les en un seul fichier comme décrit à l'étape 7 de la section Configurer le cryptage SSL. Pour plus d'informations, voir Paramètres HTTPS et Configurer le cryptage SSL.
Syslog
syslog.enabled
Valeur booléenne permettant d'activer ou de désactiver la journalisation système : true | false. Le réglage par défaut est true. Lorsque le serveur est démarré avec la commande Debug, ce paramètre est ignoré et les journaux s'affichent dans la console.
syslog.protocol
Protocole utilisé pour la journalisation à distance du système : BSD_UDP ou BSD_TCP. Le paramètre est ignoré lorsque syslog.host est localhost (ou 127.0.0.1 ou ::1).
syslog.host
Nom ou adresse IP de l'hôte de journalisation. La valeur par défaut est localhost. La journalisation sur localhost sur les systèmes Windows utilise le journal des événements Windows. La journalisation sur localhost sur d'autres systèmes utilise Syslog (RFC3164).
syslog.port
Valeur entière correspondant au port sur lequel le service Syslog accepte les connexions. Le port est généralement 514 ou 601 ou 6514. La valeur par défaut est 514. Le paramètre est ignoré lorsque syslog.host est localhost (ou 127.0.0.1 ou ::1). La journalisation sur localhost sur les systèmes Windows utilise le journal des événements Windows. La connexion à localhost sur d'autres systèmes utilise une connexion socket de domaine Unix locale.
L'adresse RaptorXML+XBRL ServerL'adresse HTTP du serveur se compose du socket-host et du socket-port : http://{socket-host}:{socket-port}/
L'adresse telle qu'elle est définie dans la configuration initiale sera : http://localhost:8087/
Pour modifier l'adresse, modifiez les paramètres http.socket-host et http.socket-port dans le fichier de configuration du serveur, server_config.xml. Par exemple, supposons que la machine serveur ait une adresse IP de 123.12.123.1 et que les paramètres de configuration du serveur suivants aient été définis : <http.socket-host>0.0.0.0</http.socket-host>
RaptorXML+XBRL Server peut alors être adressé avec : http://123.12.123.1:8087/ |
Note : une fois le fichier server_config.xml modifié, il est nécessaire de redémarrer RaptorXML+XBRL Server pour que les nouvelles valeurs soient appliquées.
Note : en cas de problèmes de connexion à RaptorXML+XBRL Server, les informations contenues dans les fichiers nommés dans http.access-file et http.error-file peuvent aider à résoudre les problèmes.
Note : les messages envoyés à RaptorXML+XBRL Server doivent contenir des noms de chemin d'accès valides sur le serveur. Les documents stockés sur le serveur sont accessibles localement ou à distance (dans ce dernier cas, à l'aide d'URI HTTP, par exemple).