Configurer le serveur

www.altova.com Imprimer cette rubrique Page précédente Un niveau supérieur Page suivante

Accueil >  API serveur : REST HTTP, COM/.NET, Java > Interface Client HTTP > Configuration de serveur >

Configurer le serveur

Cette section :

 

Fichier de configuration de serveur : paramètres de base
Fichier de configuration de serveur : modifier les paramètres de base, retourner aux paramètres de base
Fichier de configuration de serveur : liste et paramètres
Fichier de configuration de serveur : description des paramètres
Configurer l'adresse de serveur

 

Fichier de configuration de serveur : paramètres de base

RaptorXML+XBRL Server est configuré au moyen d'un fichier de configuration appelé server_config.xml, qui est situé par défaut sous :

 

C:\Program Files (x86)\Altova\RaptorXMLXBRLServer2019\etc\server_config.xml

 

La configuration initiale pour RaptorXML+XBRL Server définit les éléments suivants :

 

Un numéro de port de 8087 en tant que le port de serveur.
Que le serveur écoute uniquement les connexions locales (localhost).
Que le serveur écrit la sortie sous C:\ProgramData\Altova\RaptorXMLXBRLServer2019\Output\.

 

Les autres paramètres par défaut sont affichés dans la liste de server_config.xml ci-dessous.

 

Fichier de configuration de serveur : modifier les paramètres de base, retourner aux paramètres de base

Si vous souhaitez changer les paramètres de base, vous devez éditer le fichier de configuration de serveur, server_config.xml (voir la liste ci-dessous), l'enregistrer, puis redémarrer RaptorXML+XBRL Server en tant que service.

 

Si vous souhaitez recréer le fichier de configuration de serveur original (de manière à ce que le serveur soit à nouveau configuré avec les paramètres de base), exécuter la commande createconfig:

 

 RaptorXMLXBRL.exe createconfig

 

Lors de l'exécution de cette commande, le fichier de paramètres de base sera recréé et écrasera le fichier server_config.xml. La commande createconfig est utile si vous souhaitez réinitialiser la configuration de serveur pour les paramètres de base.

 

Fichier de configuration de serveur : liste et paramètres

Le fichier de configuration de serveur, server_config.xml, est listé ci-dessous avec les paramètres de base. Les paramètres disponibles s'y trouvant sont expliqués en-dessous de la liste.

 

 

server_config.xml

 

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

xsi:schemaLocation="http://www.altova.com/schemas/altova/raptorxml/config 
http://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\RaptorXMLXBRLServer2019\output\</server.output-root-dir>

  <server.script-root-dir>C:\Program Files\Altova\RaptorXMLXBRLServer2019\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\RaptorXMLXBRLServer2019\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\RaptorXMLXBRLServer2019\Log\access.log</http.access-file>

<http.error-file>C:\ProgramData\Altova\RaptorXMLXBRLServer2019\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\RaptorXMLXBRLServer2019\etc\cert\key.pem</https.private-key>

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

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

 

</config>

 

Paramètres

 

language

Configure la langue des messages de serveur, dans un élément language optionnel. 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 les Commandes de localisation pour une description de la localisation de RaptorXML.

 

 

server.unrestricted-filesystem-access

 

Une fois définis sur true (la valeur par défaut), les fichiers de sortie seront écrits directement dans l'emplacement spécifié par l'utilisateur et dans les scripts Python (écrasant éventuellement les fichiers existants du même nom). Veuillez noter, néanmoins, que les chemins de fichiers locaux ne peuvent pas être utilisés pour accéder aux fichiers depuis une machine à distance par HTTP. Donc, si RaptorXML+XBRL Server est exécuté sur une machine à distance, régler la valeur de cette option sur false. Le réglage de la valeur sur true est uniquement viable si le client et le serveur se trouvent sur la même machine et que vous souhaitez écrire les fichiers de sortie sur un répertoire dans cette machine.
Si définis sur false, les fichiers seront écrits dans le répertoire de la tâche dans le répertoire de sortie, et les URI de ces fichiers seront inclus dans le document de résultat. La configuration de la valeur sur false fournit un niveau de sécurité, puisque les fichiers peuvent uniquement être écrits sur le disque dans un répertoire de tâche réservé et connu sur le serveur. Les fichiers de sortie de tâche peuvent ensuite être copiés par des moyens autorisés dans d'autres emplacements.

 

 

server.output-root-dir

Le répertoire dans lequel la sortie de toutes les tâches soumises est enregistrée.

 

 

server.script-root-dir

Le répertoire dans lequel scripts Python de confiance doivent être enregistrés. L'option script, lorsqu'utilisée par le biais de l'interface HTTP, fonctionnera uniquement si des scripts provenant de ce répertoire de confiance sont utilisés. La spécification d'un script Python provenant d'un autre répertoire entraînera un erreur. Voir Rendre les Scripts Python sûrs'.

 

 

server.default-script-api-version

La version API Python par défaut utilisés pour exécuter les scripts Python. Par défaut, la version la plus récente de l'API Python est utilisée. Les valeurs prises en charge actuellement sont 1 et 2. 

 

 

server.catalog-file

L'URL du fichier catalogue XML à utiliser. Par défaut, le fichier catalogue RootCatalog.xml, qui est situé dans le dossier <ProgramFilesFolder>\Altova\RaptorXMLXBRLServer2019\etc, sera utilisé. Utiliser le paramètre server.catalog-file uniquement si vous souhaitez modifier le fichier de catalogue par défaut.

 

 

server.log-file

Le nom et l'emplacement du fichier de log de serveur. Les événements sur le serveur, comme Server started/stopped, sont connectez en continu dans le journal de l'événement du système et affiché dans un visionneur de l'événement de système comme par exemple Windows Event Viewer. Outre l'affichage du visionneur, les messages de journal peuvent aussi être écrits sur le fichier spécifié avec l'option server.log-file. Le fichier de journal de serveur contiendra des informations concernant des activités sur le serveur, y compris les erreurs de lancement de serveur, le fichier de configuration utilisé, et les erreurs de licence.

 

 

http.enable

Une valeur booléenne pour activer ou désactiver HTTP: true | false. HTTP peut être activé/désactivé indépendamment ou HTTPS, et les deux peuvent être actifs en parallèle.

 

 

http.environment

Les environnements interne de raptorxml: production | development. L'environnement de Développement sera plus adapté aux besoin des développeurs, permettant un débogage plus simple que lorsque l'environnement de Production est utilisé.

 

 

http.socket-host

L'interface par le biais duquel RaptorXML+XBRL Server est accédé. Si vous souhaitez que RaptorXML+XBRL Server accepte les connexions depuis les machines à distance, décommenter l'élément et définir son contenu sur : 0.0.0.0, comme cela : <http.socket-host>0.0.0.0</http.socket-host>. Cela héberge le service sur toute interface adressable sur l'appareil de serveur. Dans ce cas, s'assurer que les paramètres du pare-feu sont configurés correctement. Les exceptions de pare-feu entrantes 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

Le port sur lequel le service est accédé. Le port doit être fixe et connu de manière à ce que les requêtes HTTP puissent être adressées correctement au service.

 

 

http.log-screen

Si RaptorXML+XBRL Server est lancé avec la commande RaptorXMLXBRLServer.exe debug, (voir Lancer le serveur) et si http.log-screen est configuré sur true, alors l'activité du serveur est affichée dans la console de la ligne de commande. Sinon, l'activité du serveur n'est pas affichée. L'écran journal est affiché en plus de l'écriture dans les fichiers journaux.

 

 

http.access-file

Le nom et l'emplacement du fichier d'accès HTTP. Le fichier d'accès contient des informations concernant l'activité liée aux accès. Il contient des informations utiles pour résoudre les problèmes de connexion.

 

 

http.error-file

Le nom et l'emplacement du fichier d'erreur HTTP. Le fichier d'erreur contient des erreurs liées au trafic provenant de et allant vers le serveur. En cas de problèmes de connexion, ce fichier peut fournir des informations utiles concernant la résolution d'erreur.

 

 

http.max_request_body_size

Cette option spécifie la taille maximum du corps de requête que RaptorXML+XBRL Server accepte. La valeur par défaut est de 100MO. Si la taille d'un corps de requête est plus grand que la valeur spécifiée pour cette option, alors 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 avec http.max_request_body_size=0.

 

 

https.enable

Une valeur booléenne pour activer ou désactiver HTTPS: true | false. HTTPS peut être activé/désactivé indépendamment de HTTP, et tous les deux peuvent être actives en parallèle. La prise en charge HTTPS est désactivée par défaut et doit être activée en changeant la valeur de ce paramètre sur true.

 

 

https.socket-host

Prend une valeur string qui est l'adresse hôte sur laquelle les connexions HTTP sont acceptées. Pour accepter les connexions depuis l'hôte local uniquement, définir localhost ou 127.0.0.1. Si vous souhaitez que RaptorXML+XBRL Server accepte les connexions provenant de toutes les machines à distance, définir la valeur sur : 0.0.0.0, comme ceci : <http.socket-host>0.0.0.0</http.socket-host>. Cela héberge le service sur chaque interface adressable de la machine du serveur. Dans ce cas, veuillez vous assurer que les paramètres de pare-feu sont correctement configurés. Les exceptions pare-feu entrantes pour les produits Altova doivent être enregistrés tels que suit : Altova LicenseServer : port 8088; Altova RaptorXML+XBRL Server : port 8087; Altova FlowForce Server : port 8082. Vous pouvez aussi utiliser des adresses IPv6 comme : '::'.

 

 

https.socket-port

Une valeur de nombre entier qui est le port sur lequel HTTPS est accepté. Le port doit être fixé et connu de manière à ce que les requêtes HTTP peuvent être adressées correctement au service.

 

 

https.private-key, https.certificate

Les URI qui sont les chemins, respectivement, à la clé privée du serveur et les fichiers de certificat. Les deux sont nécessaires. Voir Paramètres HTTPS et Configurer l'encodage SSL pour plus d'informations. Sur les appareils Windows, vous pouvez aussi utiliser des chemins Windows.

 

https.certificate-chain

Un paramètre optionnel. il s'agit d'un URI qui situe le fichier de certificat intermédiaire. Si vous avec deux certificats intermédiaires (primaire et secondaire), puis de les combiner en un fichier tel que décrit dans l'étape 7 de Configurer l'encodage SSL. Voir Paramètres HTTPS et Configurer l'encodage SSL pour plus d'informations.

 

L'adresse RaptorXML+XBRL Server

L'adresse HTTP du serveur consiste en : socket-host et socket-port :

http://{socket-host}:{socket-port}/

 

L'adresse telle que configurée avec la configuration de base sera :

http://localhost:8087/

 

Pour changer l'adresse, modifier les paramètres http.socket-host et http.socket-port dans le fichier de configuration de serveur, server_config.xml. Si par exemple, le serveur a une adresse IP de 123.12.123.1, et que les paramètres de configuration de serveur suivants ont été fait :

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

 

RaptorXML+XBRL Server peut ensuite être adressé avec :

http://123.12.123.1:8087/

 

 

Note :Une fois que server_config.xml aura été modifié, RaptorXML+XBRL Server doit être redémarré pour que les nouvelles valeurs soient appliquées.

 

Note :Si vous être confronté à des problèmes de connexion à RaptorXML+XBRL Server, l'information dans les fichiers nommé dans http.access-file et http.error-file peut aider à résoudre des problèmes.

 

Note :Les messages soumis à RaptorXML+XBRL Server doivent contenir les noms de chemin qui sont valides sur le serveur. Les documents sur le serveur peuvent être accédés soit localement soit à distance (dans le deuxième cas avec des URI HTTP, par exemple).

 


© 2019 Altova GmbH