Cliente SIOM2 Manual de usuario

Cliente SIOM2 Manual de usuario Alfonso XI, 6 28014 Madrid F(+34) 91 524 03 96 www.omie.es Ref. MU_ClienteSIOM2.docx Versión 4.0 Fecha: 2013-03-22 ...
2 downloads 0 Views 1MB Size
Cliente SIOM2 Manual de usuario

Alfonso XI, 6 28014 Madrid F(+34) 91 524 03 96 www.omie.es

Ref. MU_ClienteSIOM2.docx Versión 4.0 Fecha: 2013-03-22

ÍNDICE 1

INTRODUCCIÓN

3

1.1

DESCRIPCIÓN GENERAL

3

2

INSTALACIÓN

4

2.1 2.2 2.3 2.4 2.5 2.6

PRERREQUISITOS MÁQUINA VIRTUAL JAVA INSTALACIÓN INICIAL CONFIGURACIÓN DEL MÓDULO CLIENTE SIOM2 CONFIGURACIÓN DEL LOG INSTALACIÓN INICIAL

4 4 5 5 8 8

3

FUNCIONAMIENTO

9

3.1 3.2 3.3 3.4 3.5 3.6 3.7 3.8 3.9 3.10

ARRANQUE VENTANA PRINCIPAL LENGÜETA SOAP MENÚ PRINCIPAL GENERAR PETICIÓN ENVÍO DE DATOS MODIFICACIÓN DE DATOS CONSULTAS GENERALES CONSULTAS DE DATOS ENVIADOS CENTRO DE DESCARGAS

9 10 11 13 14 15 16 17 18 19

4

TARJETA REMOTA

20

4.1 4.2 4.3 4.4 4.5

INTRODUCCIÓN INSTALACIÓN INICIAL CONFIGURACIÓN DEL MÓDULO TARJETA REMOTA CONFIGURACIÓN DEL LOG FUNCIONAMIENTO

20 21 21 22 23

5

MÓDULO DE FIRMA EN XML-SIGNATURE

25

5.1 5.2 5.3

INTRODUCCIÓN UTILIZACIÓN DEL MÓDULO FUNCIONAMIENTO DEL MÓDULO

25 25 25

Versión 4.0

MU_ClienteSIOM2.docx

Pág. 2 de 26

1 INTRODUCCIÓN 1.1

Descripción general

El Módulo Cliente SIOM2 es un ejemplo de utilización de los WebServices (o Servicios Web) desarrollados dentro del proyecto SIOM2. Dicho módulo cliente está basado en un interfaz de usuario que facilita la ejecución de los mencionados servicios por un operador humano a modo de ejemplo, y que proporciona información de utilidad para el desarrollo posterior de un sistema corporativo por parte de cada Agente del Mercado para la conexión al servidor SIOM2. Por tanto, el Módulo Cliente SIOM2 no se ha diseñado para su uso diario por los usuarios para la conexión al servidor SIOM2 de producción, ya que carece de muchas de las facilidades de uso que sí están presentes en el interfaz Web del Mercado (como las respuestas incrementales a los envíos masivos, accesos a detalle, consultas relacionadas, conversión automática a mayúsculas al realizar consultas, etc.). Por lo tanto, el Módulo Cliente SIOM2 se entrega con el único propósito de simplificar las tareas de adaptación de los sistemas corporativos de los Agentes, proporcionando: 

Funciones de bajo nivel para el acceso al certificado de la tarjeta de seguridad o al certificado software proporcionado por OMIE, conexión HTTPS, firma digital y tratamiento del protocolo SOAP.



Consultas en los nuevos formatos XML de intercambio de datos con OMIE, de forma que el Agente puede familiarizarse con dichos formatos.



Funciones de envío de datos en formato XML, con el objeto de ser capaces de probar el resultado de enviar ficheros generados por el Agente.



Información detallada de todas las peticiones realizadas y respuestas recibidas para cada uno de los servicios a los que puede conectarse el cliente.



Un interfaz de usuario básico para la realización de estas acciones.

Versión 4.0

MU_ClienteSIOM2.docx

Pág. 3 de 26

2 INSTALACIÓN 2.1

Prerrequisitos

Los requisitos mínimos para la instalación del Módulo Cliente SIOM2 son los siguientes:

2.2

o

Windows XP / Windows 7 / Windows 8.

o

Procesador Pentium III ó superior.

o

Memoria RAM 128 MB ó superior (recomendado 256 MB).

o

250 MB de espacio libre en disco duro recomendado.

Máquina Virtual Java

El Módulo Cliente SIOM2 es un programa realizado en Java, que necesita un entorno de ejecución o Máquina Virtual Java (Java Virtual Machine o JVM). Aunque las diferentes JVM que existen en el mercado han de ser compatibles, y cualquiera de ellas podría servir como entorno de ejecución del Cliente SIOM2, todos los desarrollos y pruebas se han realizado sobre la JVM de referencia en el mercado, que es la JVM de Sun, que puede utilizarse libremente. Por este motivo, la JVM de Sun es la única soportada oficialmente. El Cliente SIOM2 está soportado oficialmente a partir de la JVM 1.6.0. La última versión soportada se encuentra disponible en el área de descargas de la ayuda de SIOM2 del Web del Mercado. Se recomienda la instalación Offline, frente a la instalación Online que ofrece Sun, ya que con ésta última se han detectado ciertos problemas en algunas configuraciones. OMIE proporciona el ejecutable de instalación en las páginas de ayuda del Web del Mercado para SIOM2. La instalación de la JVM de Sun es sencilla, y se inicia al ejecutar el programa de instalación. En el caso en que el Cliente SIOM2 se vaya a utilizar desde una máquina desde la cual no se realiza la conexión a OMIE mediante el navegador, la instalación de la JVM puede realizarse de forma directa, pudiendo realizar la instalación típica y contestando las pantallas intermedias con las opciones que parecen por defecto. Una vez finalizada la instalación, se debe añadir al path del sistema, la ubicación de la JVM que acabamos de instalar, para ello, realizamos los siguientes pasos con un usuario con perfil de Administrador:



o

Seleccionar: “Inicio/Configuración/Panel de Control/Sistema” y elegir la lengüeta “Avanzado”

o

Pulsar el botón “Variables de Entorno”, y seleccionar dentro de la sección “Variables del Sistema” la variable “Path”. Pulsar el botón “Editar”.

o

El contenido de la variable “Path” debe modificarse para que aparezca en primer lugar el directorio donde están ubicados los ejecutables de la Máquina Virtual de Sun (típicamente instalados en “C:\Archivos de programa\Java\jre7\bin” o similar).

Nota: La forma de realizar la modificación en la variable “Path” Puede variar ligeramente respecto a los pasos descritos dependiendo del Sistema Operativo. En caso de duda, consulte con su administrador.

En algunos casos, se han detectado problemas de instalación debidos a que ya existía una máquina virtual más antigua instalada previamente. Por ello, una vez instalada la máquina virtual, debe verificarse que ésta es la máquina virtual que va a utilizarse al arrancar el módulo cliente. Para ello, deben seguirse los siguientes pasos: o

Versión 4.0

Arrancar una ventana de comandos del sistema operativo, seleccionando: “Inicio/Programas/Accesorios/Símbolo del Sistema” o ”Inicio/Programas/Símbolo del Sistema” (dependiendo del Sistema Operativo), o bien seleccionar “Inicio/Ejecutar” y escribir “cmd” como nombre del programa. MU_ClienteSIOM2.docx

Pág. 4 de 26

2.3

o

Junto al “prompt” del Sistema Operativo (típicamente “C:\>”) escribir “java –version”

o

Debe obtenerse una respuesta similar a la que se adjunta, donde la versión que se indica en la primera línea de la respuesta debe ser “1.6.0_30” o superior.

Instalación Inicial

La instalación del Módulo Cliente SIOM2 consiste en realizar una copia del directorio de ficheros “Siom2”, dentro del directorio “C:\OMEL\” de la máquina cliente. El directorio “C:\OMEL\” debe crearse previamente. El Módulo Cliente SIOM2 se descarga de las páginas de ayuda del Web del Mercado. Se obtendrá un fichero ZIP, cuyo contenido debe extraerse en un directorio temporal. Una vez extraído, ejecutar el fichero copiaCliente.bat. Este ejecutable copiará los binarios del ClienteSIOM2 a su ruta definitiva en “C:\OMEL\”, respetando la estructura de directorios de los ficheros en el ZIP. La estructura de directorios resultante será la siguiente (dentro de C:\OMEL): 

C:\OMEL\Siom2: Ficheros de configuración y ficheros BAT de ejecución del Módulo Cliente y de las diferentes utilidades. -

\Classes: directorio de clases de la aplicación.

-

\Libs: directorio de librerías de la aplicación.

Otros directorios que aparecen tras la ejecución de las diferentes funcionalidades del Módulo Cliente SIOM2 son los siguientes:

2.4

-

\descAuto: directorio para la descarga automática que se ejecuta dentro del Cliente SIOM2.

-

\Log: directorio en el que se guarda el fichero de log.

-

\Multidescarga: directorio para la multidescarga que se ejecuta dentro del Cliente SIOM2.

-

\Trans: directorio de almacenamiento de todas las transacciones SOAP realizadas (peticiones y respuestas).

-

\Xsd: directorio de los ficheros xsd (esquemas XML de intercambio).

Configuración del Módulo Cliente SIOM2

Existe un fichero de configuración llamado “config.xml” ubicado en el directorio “c:\omel\siom2\” en el que se encuentra la información de configuración necesaria para la aplicación. Es un fichero xml con una serie de elementos que pueden aparecer o no, pueden estar rellenos o vacíos. En cada caso el funcionamiento de la aplicación será diferente. Este fichero no existe tras la instalación inicial, sino que se crea automáticamente durante la primera ejecución del Módulo Cliente SIOM2. En posteriores ejecuciones, si ya existía el fichero, éste no se reemplaza, sino que se respeta el fichero existente, con los cambios de configuración que haya realizado el usuario. A continuación se describe el contenido de dicho fichero.

Versión 4.0

MU_ClienteSIOM2.docx

Pág. 5 de 26



Dirección servidor



del



Configuración de la conexión



Configuración



del Proxy



(si existe)



Información



local

Configuración de los certificados



Información



remota



Idioma por defecto



Lengüeta SOAP



Directorio de



transacciones

Configuración del interfaz



Versión 4.0

MU_ClienteSIOM2.docx

Pág. 6 de 26

En este fichero es únicamente es necesario que exista la información de la dirección del servidor, que estará cumplimentada en el fichero de configuración incluido en la instalación básica. En el caso de que esta no exista, el Módulo Cliente no podrá conectarse con él para las llamadas a los servicios. El resto de opciones son: -

Configuración del proxy: en el caso de existir proxy y de que la conexión se realice a través de él, es necesario incluir la dirección y puerto del proxy en el fichero de configuración. Puede o no ser necesario especificar un usuario y un password. En el caso de que se indique, la conexión se establecerá con dicho usuario. Si no se va a utilizar proxy, debe eliminarse del fichero de configuración el elemento ConfigProxy completo.

-

Información del certificado local: si el valor del atributo “tipo” es “local”, puede rellenarse la información relativa a los certificados locales. Existen una serie de posibilidades: o

o

o

Si el valor del atributo “soporte” es “tarjeta”, o no se especifica, deberá introducirse el código del certificado y el PIN. 

En el caso de que no se rellenen el Módulo pedirá los datos mediante una pantalla en la que se elige el certificado y se introduce el PIN.



En el caso de que exista solo la información relativa al nombre del certificado, también se mostrará una ventana para introducir el PIN, pero en este caso, el certificado introducido estará seleccionado.



En el caso de que toda la información esté completa y sea correcta, no se producirá ninguna interacción con el usuario.

Si el valor del atributo “soporte” es software, deberá introducirse como certificado el “path” al fichero “.p12” en el que se facilitó el certificado, y el PIN de protección: 

En el caso en el que no se especifique el fichero p12 con el certificado o el PIN, se mostrará un error y el Módulo Cliente no continuará.



En el caso de que toda la información esté completa, el Módulo Cliente arrancará sin ninguna interacción con el usuario.

Si el valor del atributo “soporte” es sistema, deberá introducirse el nombre del certificado registrado en el sistema operativo: 

En el caso en el que no se especifique ningún certificado, se mostrará una ventana, listando todos los certificados registrados en el sistema.



Tras seleccionar el certificado deseado, el sistema operativo se comportará de acuerdo al modo en que fue registrado el certificado (solicitando un PIN, solicitando confirmación de uso del certificado, o accediendo sin ninguna interacción con el usuario).

-

Información del certificado remoto: en el caso de que en el atributo “tipo” aparezca la palabra “remoto”, será necesario rellenar los datos de dirección y puerto del tarjetero remoto (ver descripción del servidor de tarjeta remota).

-

Presentación SOAP: permite configurar el atributo “activo” con los valores “S” o “N”, en el caso de “S” (o de no aparecer), los paneles SOAP mostrarán el xml formateado mediante una hoja de estilo, en el caso de “N” el xml aparece en formato texto.

-

Idioma por defecto: es posible indicarle un idioma en el fichero de configuración para evitar tener que responder cada vez a la pregunta del idioma. En el caso de que no exista o este sea incorrecto (por inválido o por no estar soportado), el sistema ignorará dicho dato y pregunta por el idioma con una ventana de selección.

-

Directorio de transacciones: permite configurar el atributo “activo” con los valores “S” o “N”, en el caso de “S”, todas las transacciones entre el Módulo Cliente y el Servidor estarán almacenadas en el directorio que se indica dentro de dicho elemento en forma de mensajes SOAP de invocación de servicios y respuestas SOAP.

Versión 4.0

MU_ClienteSIOM2.docx

Pág. 7 de 26

Nota: Activar dicho parámetro pude llegar a generar varios miles de ficheros a lo largo de un día normal de operación, por lo que se recomienda llevar un mantenimiento de dicho directorio.

2.5

Configuración del Log

El Módulo Cliente SIOM2 utiliza un mecanismo de Log proporcionado por una utilidad de uso libre denominada “Log for Java” o “log4j”, que utiliza su propio fichero de configuración. La instalación estándar del Módulo Cliente SIOM2 incluye un fichero de configuración, ubicado en “C:\Omel\Siom2\log4j.properties”. Este fichero no existe tras la instalación inicial, sino que se crea automáticamente durante la primera ejecución del Módulo Cliente SIOM2. En posteriores ejecuciones, si ya existía el fichero, éste no se reemplaza, sino que se respeta el fichero existente, con los cambios de configuración que haya realizado el usuario. A continuación se indican las características de configuración con las que se crea dicho fichero: 

Nivel de log “INFO”



Escritura a un fichero de log ubicado en “C:\Omel\Siom2\Log\Siom2.log”, indicando la fecha y hora, el nivel de log y el mensaje. Este fichero se reemplaza en cada ejecución del Módulo Cliente SIOM2.



Escritura en la consola Java de los mismos mensajes.

En principio, no es necesario modificar el fichero de configuración del Log. Si se desea modificar la información que aparece en el mismo, o utilizar otros mecanismos de salida (a Base de Datos, mensajes vía sockets, u otros mecanismos soportados por “log4j”), debe consultarse la documentación existente en “jakarta.apache.org/log4j/docs/index.html”

2.6

Instalación Inicial

En el caso en que sea necesario actualizar el Módulo Cliente SIOM2 con una nueva versión facilitada por OMIE, bastará con descomprimir el nuevo fichero ZIP proporcionado, confirmando que se desea siempre reemplazar los ficheros existentes con los nuevos ficheros provenientes del ZIP. Si se desea realizar una instalación más limpia, se puede borrar el directorio “C:\OMEL\Siom2” completo, o realizar una copia de seguridad del mismo, antes de descomprimir el ZIP. De esta forma, se evita que puedan quedar elementos no utilizados dentro de los directorios. En cualquier caso, tal como se ha explicado anteriormente, los ficheros “config.xml” y “log4j.properties” pueden conservarse, sobre todo si se han realizado cambios que no se desea perder. El contenido de dichos ficheros será respetado tanto al descomprimir el ZIP como al ejecutar la aplicación. Por otro lado, el contenido de los directorios “descAuto”, “Log”, “Multidescarga”, “Trans” y “xsd” no necesitan ser borrados, ya que la aplicación los utilizará adecuadamente, tanto si existen antes de la ejecución como si no.

Versión 4.0

MU_ClienteSIOM2.docx

Pág. 8 de 26

3 FUNCIONAMIENTO 3.1

Arranque

Durante el arranque de la aplicación, se realizan los siguientes pasos: -

Lectura del fichero de configuración. Establecimiento del certificado de conexión al servidor. Obtención de los datos de usuario. Establecimiento del idioma. Petición de la hora remota. Consulta del estado de los mercados.

Todos estos pasos pueden verificarse en la consola del Log del módulo cliente:

En el caso de que no haya un idioma definido en el fichero de configuración, o se haya definido un idioma incorrecto o no soportado, aparecerá una ventana de elección del idioma que desplegará un combo con los idiomas disponibles. Es posible elegir “idioma por defecto” en este caso no se establecerá ningún idioma y la aplicación utilizará el de por defecto (español). Si hay un idioma definido en el fichero de configuración se envía directamente ese.

Versión 4.0

MU_ClienteSIOM2.docx

Pág. 9 de 26

Ocurre algo similar con los certificados. Existe la posibilidad de especificar en el fichero de configuración el certificado, con o sin su PIN. En el caso de no haber ninguno, y cuando el soporte elegido sea tarjeta, se presentará una ventana con los certificados presentes en la tarjeta. Si hay un certificado elegido sin PIN, aparecerá la misma ventana con el certificado elegido seleccionado dentro de los presentes en la tarjeta.

Si se han establecido todos los datos, no se presentará ninguna ventana y el procedimiento se realizará internamente. En caso de utilizar un certificado ubicado en una tarjeta, una vez establecido el certificado se realiza la comprobación de que la tarjeta insertada en el tarjetero sea la correcta y se detecta su extracción en todo momento, cerrando en ese caso la aplicación. En el caso, de acceder mediante un certificado del sistema, y no se ha establecido ninguno en el archivo de configuración, aparecerá una nueva ventana listando los certificados encontrados.

3.2

Ventana principal

Al arrancar y establecer el idioma aparece la aplicación con el menú, el reloj y los datos del mercado.

Versión 4.0

MU_ClienteSIOM2.docx

Pág. 10 de 26

El reloj funciona de forma similar al marco superior del interfaz del Web de Operación del mercado, realiza cinco peticiones de hora y hace una serie de cálculos antes de presentar la hora remota. Por otra parte está la consulta de estado de los mercados. Una sola petición, que se realiza periódicamente cada 30 segundos, da la información necesaria para presentar los datos en la parte superior. En el caso de que estos datos informen de que hay mensajes activos (y también en el caso de pinchar el icono de mensajes) se realiza una consulta de mensajes.

3.3

Lengüeta SOAP

Con objeto de facilitar información técnica del modo de interaccionar con el servidor WebServices de SIOM2, se ha incluido en varios puntos del módulo cliente, una ventana especial, o ventana “SOAP”, que muestra para cada petición, el formato completo de llamada al WebService, así como el formato completo de la respuesta obtenida. Para acceder a las peticiones y respuestas relativas a los servicios ejecutados durante el arranque del módulo cliente (fecha y hora, datos del usuario, información de los mercados, etc.), puede utilizarse el icono “SOAP” situado en la parte central inferior de la ventana principal. La siguiente captura muestra un ejemplo de ventana “SOAP” para la obtención del listado de idiomas soportados. El panel superior presenta el formato de llamada, y el panel inferior presenta el formato de respuesta:

Versión 4.0

MU_ClienteSIOM2.docx

Pág. 11 de 26

Este tipo de ventana o panel se utiliza asimismo en otros puntos del módulo cliente, ilustrando en cada caso los formatos de llamada y respuesta de los servicios correspondientes. Ambos paneles tienen habilitada una opción, que se activa con el “botón derecho” del ratón, en el que aparece la opción de “Guardar como…”, sirve para guardar el archivo mostrado en un fichero xml. Aparece una ventana de navegación de directorios.

En el caso de que se intenten mostrar peticiones o respuestas muy grandes, el resultado que se muestra en estos paneles puede aparecer cortado, para evitar que se produzcan errores por exceso de uso de memoria en el cliente. Esta situación se hará evidente al observar unos puntos suspensivos al final del panel:

Si se necesita ver el fichero al completo se puede utilizar la opción de “guardar como…”, y abrirlo con un editor de textos o un editor XML.

Versión 4.0

MU_ClienteSIOM2.docx

Pág. 12 de 26

3.4

Menú Principal

El menú aparece como una barra en la parte superior de la aplicación y consta de las siguientes opciones: -

-

-

-

Archivo: o Generar petición: en esta opción se abre una ventana que permite realizar llamadas a servicios de forma genérica y más flexible. o Salir: cierra la aplicación. Envío: Se muestran las opciones de envío de información vigentes para los mercados Diario e Intradiario. Abren una ventana aparte. Modificaciones: Se muestran las opciones de anulación y retirada de datos vigentes para los mercados Diario e Intradiario. Abren una ventana aparte. Consultas generales: este menú se compone dinámicamente mediante el resultado de la llamada a un WebService que indica el directorio de consultas disponibles. Cualquiera de las opciones de este menú abre una ventana con un una adaptación del Applet de Consultas del interfaz del Web de Operación. Consultas de datos enviados: Se muestran las opciones vigentes de consulta de datos enviados, que se recuperan en el mismo formato en que se enviaron. Abren una ventana aparte. Descargas: Donde se realizan las descargas de Certificados y facturas, y se incluye una adaptación del Centro de Descargas del Web del Mercado. Ayuda : o Acerca de…: muestra la siguiente ventana de información al cliente

Versión 4.0

MU_ClienteSIOM2.docx

Pág. 13 de 26

3.5

Generar petición

Consta de dos lengüetas, en la principal aparece una ventana contiene: -

-

Panel de petición SOAP desde fichero: permite enviar una transacción SOAP completa, con o sin firma, almacenada en un fichero. Consta de los siguientes elementos: o Campo para introducir el nombre del fichero con el sobre SOAP que se desea enviar. o Botón de búsqueda de fichero o Botón de envío. Panel de generación de petición SOAP a traves de parámetros XML: permite generar un sobre SOAP eligiendo un servicio y un fichero de parámetros en formato XML (por ejemplo, un fichero de ofertas). Consta de los siguientes elementos: o Lista de selección con todos los servicios disponibles. o Botón de búsqueda de fichero o Botón de envío. o Una serie de opciones:  Opción de firmar la petición (el sobre SOAP).  Parámetros (sin parámetros o con fichero XML): en el caso de que se active la opción de con fichero, es necesario rellenar el campo o buscar el fichero mediante el botón de búsqueda.  Opción de validación del esquema en local.

Versión 4.0

MU_ClienteSIOM2.docx

Pág. 14 de 26

Pueden darse distintos casos: -

-

-

Invocación de un servicio sin parámetros: si el servicio lleva parámetros, se obtendrá un error del servidor. En el caso de no necesitarlos, el servicio podría ejecutarse correctamente (dependiendo de las otras posibilidades). Invocación de un servicio sin firma: si el servicio necesita firma dará un error. En el caso de no necesitarla, el servicio podría ejecutarse correctamente (dependiendo de las otras posibilidades). Invocación de un servicio con parámetros: si el servicio no los necesita los ignora. Invocación de un servicio con firma: si el servicio no la necesita la ignora. Validación del esquema: esta validación siempre se hace en el servidor, pero existe la posibilidad de hacerla también en local, de forma que se evita enviar datos con un esquema incorrecto.

En el momento de ejecutarse el servicio la ventana activa automáticamente la lengüeta SOAP, en la que podrá visualizarse el contenido del envío y de la respuesta.

3.6

Envío de datos

Consta de dos lengüetas, en la principal aparece una ventana con un campo para escribir el path al fichero. Tiene un botón “Buscar” que abre un browser para buscar el archivo que se quiera mandar. Este archivo pasará una validación de esquema en local antes de ser enviado. También contiene un panel de respuesta en el que aparecerá la respuesta recibida, de la cual se han extraído los elementos principales y se han presentado de forma más intuitiva. En la segunda lengüeta o lengüeta SOAP se muestran los archivos SOAP intercambiados entre el cliente y el servidor.

Versión 4.0

MU_ClienteSIOM2.docx

Pág. 15 de 26

3.7

Modificación de datos

Consta de dos lengüetas, en la principal aparece una ventana con una serie de campos para escribir los parámetros de modificación (anulación o retirada), algunos de ellos con valores por defecto. Al activar el envío, se validará que se han introducido los valores obligatorios. También contiene un panel de respuesta en el que aparecerá la respuesta recibida, de la cual se han extraído los elementos principales y se han presentado de forma más intuitiva. En la segunda lengüeta o lengüeta SOAP se muestran los archivos SOAP intercambiados entre el cliente y el servidor.

Versión 4.0

MU_ClienteSIOM2.docx

Pág. 16 de 26

3.8

Consultas generales

Este apartado del menú se construye dinámicamente con una llamada a un servicio web que devuelve todas las consultas disponibles, separadas por áreas.

Cada una de ellas abre una ventana que consta de dos lengüetas, en la principal aparece un panel que es una adaptación del Applet de Consultas del interfaz Web de Operación. Realiza ejecuciones de consultas a partir de unos parámetros que vienen indicados en la configuración de la consulta, al igual que las columnas que aparecen.

Versión 4.0

MU_ClienteSIOM2.docx

Pág. 17 de 26

En la segunda lengüeta o lengüeta SOAP se muestran los archivos SOAP intercambiados entre el cliente y el servidor. Al arrancar esta ventana, mientras en la lengüeta principal se muestra el interfaz de consultas sin respuestas en la rejilla de resultados, la lengüeta SOAP muestra la petición y respuesta relativas al WebService que indica las características de la consulta. Tras ejecutar cada consulta, la lengüeta SOAP mostrará la petición y respuesta relativas al servicio de ejecución de la consulta, con los parámetros especificados por el usuario.

3.9

Consultas de datos enviados

Este apartado de menú solo tiene tres opciones y todas ellas abren una ventana similar, consta de dos lengüetas. En la lengüeta principal aparece una ventana con dos campos, Código y Versión, en los que se pueden especificar listas de valores, separadas por comas. Debe existir en cada campo en cada campo el mismo número de elementos. Así por ejemplo, para recuperar los datos de las ofertas “1234 versión 1”, “5678 versión 2” y “3456 versión 3”, debe especificarse: Código: 1234,5678,3456 Versión: 1,2,3 También contiene un panel de respuesta en el que aparece la respuesta SOAP de la cual se han extraído los datos básicos de cada oferta recuperada.. En la segunda lengüeta o lengüeta SOAP se muestran los archivos SOAP intercambiados entre el cliente y el servidor.

Versión 4.0

MU_ClienteSIOM2.docx

Pág. 18 de 26

3.10 Centro de Descargas Consta de cuatro lengüetas inferiores. En la principal aparece una adaptación del Centro de Descargas. Su funcionamiento es igual que el Centro de Descargas del interfaz del Web de Operación.

En la segunda lengüeta inferior o lengüeta “SOAP Control” se muestran los mensajes SOAP intercambiados entre el cliente y el servidor a la hora de arrancar la ventana. También se incluyen las llamadas que realiza la Descarga Automática en el momento de pedir la lista de posibles ficheros a descargar en modo automático (nada más abrir la Descarga Automática) o la lista de nuevos ficheros disponibles (tras pulsar el botón “Arrancar”). En la tercera lengüeta o lengüeta “SOAP Ficheros” se muestran los mensajes SOAP intercambiados entre el cliente y el servidor a la hora de pedir cada uno de los ficheros, excepto los ficheros F64. En la cuarta lengüeta o lengüeta “SOAP F64” se muestran únicamente los mensajes SOAP intercambiados entre el cliente y el servidor a la hora de pedir los ficheros F64.

Versión 4.0

MU_ClienteSIOM2.docx

Pág. 19 de 26

4 TARJETA REMOTA 4.1

Introducción

El módulo de Tarjeta Remota proporciona los certificados de conexión y firma para el cliente SIOM2 de forma remota. Este módulo se ha suministrado para el caso en que se desee que un Sistema Corporativo del Agente que se ejecuta en una máquina servidora (normalmente ubicada en un centro de cálculo) se conecte directamente al servidor SIOM2 de OMIE para realizar el envío de ofertas o acceder a cualquier otro servicio, sin necesidad de tener conectado directamente el lector de tarjetas (y sin necesidad por tanto de llevar la tarjeta personal al centro de cálculo). Gracias al módulo de Tarjeta Remota (o Servidor de Certificados), el tarjetero puede estar conectado a un puesto de usuario, por ejemplo el puesto desde el cual se está operando el Sistema Corporativo para activar o confirmar la conexión a OMIE. El esquema sería el siguiente: Puesto de usuario del Agente

Centro de Cálculo del Agente

Servidor SIOM2 en OMIE

En el puesto de usuario habría que instalar y configurar el módulo de Tarjeta Remota, que actuaría como un Servidor de Certificados, a la espera de recibir peticiones para autenticar conexiones al servidor de OMIE y firmar datos.

Versión 4.0

MU_ClienteSIOM2.docx

Pág. 20 de 26

4.2

Instalación Inicial

La instalación del Módulo de Tarjeta Remota consiste en realizar una copia del directorio de ficheros “TarjetaRemota”, dentro del directorio “C:\OMEL\” de la máquina cliente. El Módulo de Tarjeta Remota se descarga de las páginas de ayuda del Web del Mercado. Se obtendrá un fichero ZIP, cuyo contenido debe extraerse en un directorio temporal. Una vez extraído, ejecutar el fichero copiaTarjetaRemota.bat. Este ejecutable copiará los binarios del Módulo de Tarjeta Remota a su ruta definitiva en “C:\OMEL\”, respetando la estructura de directorios de los ficheros en el ZIP. La estructura de directorios resultante es la siguiente (dentro de C:\OMEL): 

4.3

C:\OMEL\TarjetaRemota: Ficheros de configuración y fichero BAT de ejecución del módulo. -

\Libs: directorio de librerías de la aplicación.

-

\Log: directorio en el que se guarda el fichero de log.

Configuración del Módulo Tarjeta Remota

Existe un fichero de configuración llamado “config.xml” ubicado en el directorio “c:\omel\TarjetaRemota\” en el que se encuentra la información de configuración necesaria para la aplicación. Es un fichero xml con una serie de elementos que pueden aparecer o no, pueden estar rellenos o vacíos. En cada caso el funcionamiento de la aplicación será diferente. Ejemplo de este fichero : 9999 DSIPRB1 1234 192.168.232.22 192.168.232.23 192.168.232.24 N

Versión 4.0

MU_ClienteSIOM2.docx

Pág. 21 de 26

-

Puerto de escucha: este es el puerto en el que se establecerá el servidor de certificados.

-

Certificado de conexión SSL: este elemento XML es opcional. En caso de no indicarse, aparecerá un dialogo para seleccionar el certificado de conexión SSL.

-

Direcciones permitidas: el contenido de este elemento XML es opcional. Si no se especifica ninguna dirección IP dentro de este elemento, se permitirá el acceso a cualquier dirección IP. En caso contrario, todas las direcciones IP definidas dentro de este elemento tendrán acceso al servidor. Para aquellas que no estén definidas, en modo manual se preguntará mediante un dialogo si se les quiere proporcionar acceso.

-

Modo Arranque: el contenido de este elemento XML es opcional. Su valor define el modo de arranque de la tarjeta remota. Sus valores posibles son: o

“N” (Normal): Este es el valor por defecto en caso de no haberse definido ningún valor. Es el modo de funcionamiento de la tarjeta remota adecuado para un puesto de usuario que proporciona manualmente el uso de la tarjeta a un equipo externo. En este modo de funcionamiento, se muestran pantallas de actividad al usuario y se requiere un inicio manual de la tarjeta remota tras su ejecución.

o

“A” (Automático): Es el modo de funcionamiento para un servidor que facilita a otro equipo el uso de una tarjeta conectada al primero. En este modo de funcionamiento, no se muestran pantallas con la actividad del servicio, ni se requiere inicio manual del mismo una vez ejecutado el fichero bat.

o

“S” (Servicio): Es un modo de funcionamiento análogo al anterior, pero siendo utilizado como un servicio de Windows, tras haber sido instalado dicho servicio. Para instalar el servicio en el equipo, debe ejecutarse el bat “InstalarServicioTarjetaRemota.bat”. Este archivo debe editarse antes de su ejecución para especificar la referencia correcta a la Máquina Virtual Java instalada en esa máquina, por ejemplo: "C:\Archivos de programa\Java\jre1.5.0_11\bin\client\jvm.dll"

Una vez instalado, su ejecución puede gestionarse como un servicio más en Windows (iniciar, detener, configurar el inicio automático, etc.). Para que funcione correctamente como servicio, debe haberse configurado el modo de ejecución con valor “S”. Si se desea desinstalar el servicio (“DesinstalarServicioTarjetaRemota.bat”).

4.4

del

equipo,

debe

ejecutarse

el

bat

Configuración del Log

El Módulo Tarjeta Remota utiliza el mismo mecanismo de Log que el Cliente SIOM2, “log4j”. El fichero de configuración está ubicado en “C:\Omel\TarjetaRemota\log4j.properties” con las siguientes características: 

Nivel de log “INFO”



Escritura a un fichero de log ubicado en “C:\Omel\TarjetaRemota\Log\ RemoteCard.log”, indicando la fecha y hora, el nivel de log y el mensaje.



Escritura en la consola de sistema de los mismos mensajes.



Escritura en la consola de la aplicación de los mismos mensajes.

En principio, no es necesario modificar el fichero de configuración del Log. Si se desea modificar la información que aparece en el mismo, o utilizar otros mecanismos de salida (a Base de Datos, mensajes vía sockets, u otros mecanismos soportados por “log4j”), debe consultarse la documentación existente en “jakarta.apache.org/log4j/docs/index.html”

Versión 4.0

MU_ClienteSIOM2.docx

Pág. 22 de 26

4.5

Funcionamiento

Una vez ejecutado el programa en modo “Normal”, aparecerá una ventana como esta:

Lo primero que se nos pedirá en el momento de arrancar el servidor son los certificados de conexión SSL, en el caso de no haber sido definidos en el fichero de configuración.

(certificado de conexión SSL)

Versión 4.0

MU_ClienteSIOM2.docx

Pág. 23 de 26

Una vez arrancado el programa, si hubiera un acceso de una maquina no permitida, se preguntaría si se desea darle acceso al servidor:

Una vez permitido el acceso al servidor, el cliente dispondrá del certificado de conexión para su uso.

Las diferencias de funcionamiento en modo “Automático” y en modo “Servicio” son las siguientes: 

En modo “Automático”, aparecerá directamente la ventana principal y no será necesario pulsar el botón de “Arrancar Servidor”.



En modo “Servicio”, no se mostrará ninguna ventana en pantalla. El funcionamiento podrá ser seguido únicamente a través del fichero de Log.



En ambos casos, si no se han especificado certificados de conexión, así como los PIN’s, en el fichero de configuración, o éstos son incorrectos, la ejecución se detendrá obteniéndose un mensaje de error en el fichero de Log.

Asimismo, si se recibe una petición desde una IP no incluida en la lista de IP’s permitidas, la petición será denegada sin solicitar confirmación al usuario.

Versión 4.0

MU_ClienteSIOM2.docx

Pág. 24 de 26

5 MÓDULO DE FIRMA EN XML-SIGNATURE 5.1

Introducción

Este módulo realiza la firma en formato XML-Signature de un fichero de datos de ofertas, bilaterales, etc., para su envío al servidor SIOM2 en forma de petición SOAP firmada.

5.2

Utilización del módulo

Existe un fichero ‘.bat’ que se invoca de la siguiente manera: FirmaFichero [Nombre del Servicio] [Fichero XML origen] [Fichero SOAP destino]

dónde: 

[Nombre del servicio] es el nombre del servicio que se desea invocar en el servidor SIOM2. Este nombre se utiliza para su colocación en el cuerpo de la petición SOAP, y debe corresponder con el tipo de los datos a enviar (por ejemplo: "ServicioAltaOfertasMD", "ServicioAltaOfertasMI", etc.)



[Fichero XML origen] es el path completo al fichero con los datos en XML. Dependiendo del servicio a invocar (alta de ofertas al MD, alta de ofertas al MI, alta de ejecuciones de bilaterales, etc.), este fichero debe ser conforme al esquema definido para cada tipo de mensaje (“MensajeOfertasMD”, “MensajeOfertasMI”, etc.)



[Fichero SOAP destino] es el path completo al fichero a crear, que incluirá la petición SOAP firmada con los datos del fichero XML origen.

Un ejemplo de uso es el siguiente: FirmaFichero ServicioAltaOfertasMD OfertasMD_20031201.xml OfertasMD_20031201_firmado.xml

5.3

Funcionamiento del módulo

Este módulo de firma verifica que el fichero origen es un fichero XML bien formado, aunque no verifica la conformidad con el esquema correspondiente. Tampoco verifica que el nombre del servicio sea correcto. Este tipo de validaciones se realizarían por el servidor, una vez que el fichero firmado resultante se envíe a SIOM2. Una vez verificado, se solicita al usuario la selección del certificado de firma a utilizar, así como el PIN correspondiente, tal como se muestras en la siguiente imagen.

Versión 4.0

MU_ClienteSIOM2.docx

Pág. 25 de 26

El proceso finaliza con la escritura del fichero resultado. Esta petición SOAP resultante puede ser enviada a SIOM2 por medio del Módulo Cliente SIOM2 proporcionado por OMIE. Para ello, debe seleccionarse la opción de menú "Archivo/Generar petición", y utilizar la opción "Petición SOAP completa en fichero" (mirar punto 3.6). El log de ejecución, donde quedarían registrados los posibles errores de proceso, sigue utilizando las funciones de "Log for Java", y su comportamiento se define dentro del fichero “log4j.properties”. El módulo de firma se entrega junto con su código fuente en Java (FirmaFichero.java), como ejemplo práctico de uso de las librerías de firma y creación de peticiones SOAP facilitadas por OMIE.

Versión 4.0

MU_ClienteSIOM2.docx

Pág. 26 de 26