Altova RaptorXML+XBRL Server 2024

Temas de este apartado:

•Archivo de configuración del servidor: configuración inicial

•Archivo de configuración del servidor: modificar configuración inicial, volver a la configuración inicial

•Archivo de configuración del servidor: ejemplo y opciones de configuración

•Archivo de configuración del servidor: descripción de las opciones de configuración

•Configurar la dirección del servidor

Archivo de configuración del servidor: configuración inicial

RaptorXML+XBRL Server se configura por medio de un archivo de configuración llamado server_config.xml, que se coloca por defecto en esta carpeta:

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

La configuración inicial para RaptorXML+XBRL Server define:

•El número de puerto 8087 como puerto del servidor

•Que el servidor solamente escucha a conexiones locales (localhost).

•Que el servidor escribe los resultados en la carpeta C:\ProgramData\Altova\RaptorXMLXBRLServer2024\Output\.

Las demás opciones de configuración predeterminadas aparecen más abajo en el fragmento del archivo de configuración server_config.xml.

Archivo de configuración del servidor: modificar o volver a la configuración inicial

Si quiere cambiar la configuración inicial, edite el archivo de configuración del servidor server_config.xml (ver más abajo), guárdelo y después reinicie RaptorXML+XBRL Server como servicio.

Si quiere recrear el archivo de configuración original (para volver a la configuración inicial), ejecute el comando createconfig:

 RaptorXMLXBRL.exe createconfig

Al ejecutar este comando, el archivo de configuración inicial se recrea y sobrescribe el archivo server_config.xml. Por tanto, el comando createconfig sirve para devolver al servidor a su configuración inicial de fábrica.

Archivo de configuración: opciones y ejemplo

A continuación puede ver el archivo de configuración del servidor server_config.xml en su versión original. Las opciones de configuración se explican más abajo.

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\RaptorXMLXBRLServer2024\output\</server.output-root-dir>

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

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

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

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

</config>

Opciones de configuración

language

Define el idioma de los mensajes del servidor, en el elemento opcional language. El valor predeterminado es es (español) y los valores permitidos son en|de|es|fr|ja (inglés, alemán, español, francés y japonés respectivamente). Para aprender a localizar (=traducir) RaptorXML, consulte el apartado Comandos de localización.

server.unrestricted-filesystem-access

•Si el valor es true (valor predeterminado), los archivos de salida se escriben directamente en la ubicación especificada por el cliente y en los scripts Python (y posiblemente sobrescriben los archivos ya existentes del mismo nombre). Sin embargo, no se pueden utilizar rutas de acceso de archivo locales para acceder a archivos desde un equipo remoto por HTTP. Por tanto, si RaptorXML se está ejecutando en un equipo remoto, utilice el valor false para esta opción. El valor true solo se puede usar si el cliente y el servidor están en el mismo equipo y desea escribir los archivos de salida en un directorio de ese equipo.

•Si el valor es false, los archivos se escriben en el directorio del trabajo del directorio de salida y los URI de estos archivos se incluye en el documento de resultados. Por tanto, el valor false aporta mayor seguridad, porque los archivos solo se pueden escribir en el disco en un directorio del trabajo especializado y conocido. Los archivos de salida del trabajo se pueden copiar después en otras ubicaciones.

server.output-root-dir

Directorio en el que se guardan los documentos de salida de todos los trabajos.

server.script-root-dir

Directorio en el que se deben guardar los scripts Python de confianza. Cuando se usa con la interfaz HTTP, la opción script solamente funciona si se utilizan scripts del directorio de confianza. Si especifica un script Python de otro directorio, se produce un error. Para más información consulte el apartado Trabajar con scripts Python seguros.

server.default-script-api-version

Versión predeterminada de la API de Python para ejecutar scripts de Python. Se usa por defecto la versión más reciente de la API. Los valores permitidos actualmente son 1 y 2.

server.catalog-file

La URL del archivo de catálogo XML que se debe usar. El archivo de catálogo RootCatalog.xml está por defecto en la carpeta <CarpetaArchivosProgramas>\Altova\RaptorXMLXBRLServer2024\etc. Solamente debe utilizar la opción server.catalog-file si quiere cambiar de archivo catálogo.

server.log-file

Nombre y ubicación del archivo de registro del servidor. Los eventos del servidor, como Se inició/Se detuvo el servidor, se registran continuamente en el registro de eventos del servidor y aparecen en un visor de eventos del sistema, como el visor de eventos de Windows. Además, los mensajes del registro se pueden escribir en el archivo indicado por medio de la opción server.log-file. El archivo de registro del servidor, por tanto, contiene información sobre todas las actividades del servidor, incluidos los errores de inicio del servidor, el archivo de configuración utilizado y los errores de licencia.

http.enable

Un valor booleano para habilitar o deshabilitar HTTP: true | false. HTTP puede habilitarse/deshabilitarse independientemente de HTTPS y ambos pueden estar activos simultáneamente.

http.environment

Entornos internos de raptorxml: production | development. El entorno de desarrollo development está enfocado a los requisitos de los desarrolladores y permite realizar tareas de depuración con mayor facilidad que el entorno de producción production.

http.socket-host

Interfaz por la que se accede a RaptorXML+XBRL Server. Si quiere que RaptorXML+XBRL Server acepte conexiones desde equipos remotos, quite la marca de comentario de este elemento y defina su contenido como 0.0.0.0, es decir: <http.socket-host>0.0.0.0</http.socket-host>. Esto almacena el servicio en cada interfaz direccionable del equipo servidor. En este caso, compruebe que las opciones del servidor de seguridad están configuradas correctamente. Las excepciones de entrada del servidor de seguridad para los productos de Altova deben registrarse de la siguiente manera:

•Altova LicenseServer: puerto 8088

•Altova RaptorXML+XBRL Server: puerto 8087

•Altova FlowForce Server: puerto 8082

http.socket-port

El puerto por el que se accede al servicio. El puerto debe ser fijo y conocido para que las solicitudes HTTP se puedan direccionar correctamente al servicio.

http.log-screen

Si inició RaptorXML+XBRL Server con el comando RaptorXMLXBRLServer.exe debug, (ver Iniciar el servidor) y el valor de http.log-screen es true,

la actividad del servidor aparece en la consola de la línea de comandos. De lo contrario, la actividad del servidor no se muestra en la consola. Además de aparecer en pantalla, la actividad se registra en archivos de registro.

http.access-file

Nombre y ubicación del archivo de acceso HTTP. El archivo de acceso contiene información sobre la actividad relacionada con el acceso que puede ayudarle a resolver posibles problemas de conexión.

http.error-file

Nombre y ubicación del archivo de errores HTTP. El archivo de errores contiene errores relacionados con el tráfico entrante y saliente del servidor. Si hay problemas de conexión, este archivo puede ayudarle a resolverlos.

http.max_request_body_size

Esta opción especifica el tamaño máximo del cuerpo de la solicitud que RaptorXML+XBRL Server debe aceptar. El valor predeterminado es 100MB. Si el sitio de un cuerpo de solicitud es mayor que el valor indicado en esta opción, el servidor responderá con el error HTTP 413: Entidad de solicitud demasiado larga. El valor de la opción debe superior o igual a cero. El límite se puede deshabilitar si establece esta opción como http.max_request_body_size=0.

https.enable

Un valor booleano para habilitar o deshabilitar HTTPS: true | false. HTTPS puede habilitarse/deshabilitarse independientemente de HTTP y ambos pueden estar activos simultáneamente. La opción HTTPS está deshabilitada por defecto y debe habilitarse cambiando el valor de esta opción por true.

https.socket-host

Toma un valor de cadena que es la dirección de host donde se aceptan conexiones HTTP. Para aceptar conexiones del host local solamente, defina localhost o 127.0.0.1. Si desea que RaptorXML+XBRL Server acepte conexiones de todos los equipos remotos, defina el valor 0.0.0.0, de la siguiente manera: <http.socket-host>0.0.0.0</http.socket-host>. Esto hospeda el servicio en todas las interfaces direccionables del equipo servidor. En este caso se debe comprobar que el firewall está configurado correctamente. Las excepciones de entrada del firewall para productos de Altova deben registrarse de la siguiente manera: Altova LicenseServer: puerto 8088; Altova RaptorXML+XBRL Server: puerto 8087; Altova FlowForce Server: puerto 8082. También puede usar direcciones IPv6 como: '::'.

https.socket-port

Un valor entero que es el puerto donde se acepta HTTPS. El puerto debe ser fijo y conocido para que las solicitudes HTTP se puedan dirigir correctamente al servicio.

https.private-key, https.certificate

Identificadores URI que son rutas de acceso de la clave privada del servidor y de los archivos de certificado del servidor respectivamente. Ambos son obligatorios. Consulte los apartados Configuración HTTPS y Configurar el cifrado SSL para obtener más información. En equipos Windows también puede usar rutas de acceso Windows.

https.certificate-chain

Opción opcional. Se trata de un URI que encuentra el archivo de certificado intermedio. Si tiene dos certificados intermedios (principal y secundario), combínelos en un solo archivo siguiendo las instrucciones del paso nº7 del apartado Configurar el cifrado SSL. Consulte los apartados Configuración HTTPS y Configurar el cifrado SSL para obtener más información